Changeset 82dd287 for src/SymTab

Timestamp:

Jul 9, 2015, 3:07:22 PM (9 years ago)

Author:

Aaron Moss <a3moss@…>

Branches:

ADT, aaron-thesis, arm-eh, ast-experimental, cleanup-dtors, ctor, deferred_resn, demangler, enum, forall-pointer-decay, gc_noraii, jacob/cs343-translation, jenkins-sandbox, master, memory, new-ast, new-ast-unique-expr, new-env, no_list, persistent-indexer, pthread-emulation, qualifiedEnum, resolv-new, string, with_gc

Children:

cff1143

Parents:

413f7f8

git-author:

Aaron Moss <a3moss@…> (07/08/15 16:16:21)

git-committer:

Aaron Moss <a3moss@…> (07/09/15 15:07:22)

Message:

Doc comments

Location:

src/SymTab

Files:

• FixFunction.h (modified) (1 diff)
• Validate.cc (modified) (6 diffs)
• Validate.h (modified) (1 diff)

src/SymTab/FixFunction.h

@@ -20 +20 @@
 
 namespace SymTab {
+        /// Replaces function and array types by equivalent pointer types.
         class FixFunction : public Mutator {
                 typedef Mutator Parent;

src/SymTab/Validate.cc

@@ -60 +60 @@
         class HoistStruct : public Visitor {
           public:
+                /// Flattens nested struct types
                 static void hoistStruct( std::list< Declaration * > &translationUnit );
   
@@ -84 +85 @@
         };
 
+        /// Replaces enum types by int, and function or array types in function parameter and return lists by appropriate pointers
         class Pass1 : public Visitor {
                 typedef Visitor Parent;
@@ -89 +91 @@
                 virtual void visit( FunctionType *func );
         };
-  
+
+        /// Associates forward declarations of aggregates with their definitions
         class Pass2 : public Indexer {
                 typedef Indexer Parent;
@@ -110 +113 @@
         };
 
+        /// Replaces array and function types in forall lists by appropriate pointer type
         class Pass3 : public Indexer {
                 typedef Indexer Parent;
@@ -123 +127 @@
         class AddStructAssignment : public Visitor {
           public:
+                /// Generates assignment operators for aggregate types as required
                 static void addStructAssignment( std::list< Declaration * > &translationUnit );
 
@@ -433 +438 @@
         }
 
+        /// Fix up assertions
         void forallFixer( Type *func ) {
-                // Fix up assertions
                 for ( std::list< TypeDecl * >::iterator type = func->get_forall().begin(); type != func->get_forall().end(); ++type ) {
                         std::list< DeclarationWithType * > toBeDone, nextRound;

src/SymTab/Validate.h

@@ -23 +23 @@
         class Indexer;
 
+        /// Normalizes struct and function declarations
         void validate( std::list< Declaration * > &translationUnit, bool doDebug = false );
         void validateType( Type *type, const Indexer *indexer );