Changeset 82dd287

Timestamp:

Jul 9, 2015, 3:07:22 PM (10 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

Files:

• CodeGen/FixNames.h (modified) (1 diff)
• CodeGen/Generate.h (modified) (1 diff)
• ControlStruct/CaseRangeMutator.h (modified) (1 diff)
• ControlStruct/ChooseMutator.h (modified) (1 diff)
• ControlStruct/LabelFixer.h (modified) (1 diff)
• ControlStruct/Mutate.h (modified) (1 diff)
• GenPoly/Box.cc (modified) (1 diff)
• GenPoly/Box.h (modified) (1 diff)
• GenPoly/CopyParams.h (modified) (1 diff)
• GenPoly/Lvalue.h (modified) (1 diff)
• GenPoly/Specialize.h (modified) (1 diff)
• ResolvExpr/Resolver.h (modified) (1 diff)
• SymTab/FixFunction.h (modified) (1 diff)
• SymTab/Validate.cc (modified) (6 diffs)
• SymTab/Validate.h (modified) (1 diff)
• SynTree/TypeSubstitution.h (modified) (1 diff)

src/CodeGen/FixNames.h ¶

@@ -20 +20 @@
 
 namespace CodeGen {
+        /// mangles object and function names
         void fixNames( std::list< Declaration* > translationUnit );
 } // namespace CodeGen

src/CodeGen/Generate.h ¶

@@ -23 +23 @@
 
 namespace CodeGen {
+        /// Generates code
         void generate( std::list< Declaration* > translationUnit, std::ostream &os, bool doIntrinsics );
 } // namespace CodeGen

src/ControlStruct/CaseRangeMutator.h ¶

@@ -22 +22 @@
 
 namespace ControlStruct {
+        /// expand case ranges and turn fallthru into a null statement
         class CaseRangeMutator : public Mutator {
           public:

src/ControlStruct/ChooseMutator.h ¶

@@ -22 +22 @@
 
 namespace ControlStruct {
+        /// transform choose statements into switch statements
         class ChooseMutator : public Mutator {
           public:

src/ControlStruct/LabelFixer.h ¶

@@ -25 +25 @@
 
 namespace ControlStruct {
+        /// normalizes label definitions and generates multi-level exit labels
         class LabelFixer : public Visitor {
                 typedef Visitor Parent;

src/ControlStruct/Mutate.h ¶

@@ -23 +23 @@
 
 namespace ControlStruct {
+        /// Desugars Cforall control structures
         void mutate( std::list< Declaration* > translationUnit );
 } // namespace ControlStruct

src/GenPoly/Box.cc ¶

@@ -204 +204 @@
                 }
 
-                DeclarationWithType *
-                Pass1::mutate( FunctionDecl *functionDecl ) {
+                DeclarationWithType *Pass1::mutate( FunctionDecl *functionDecl ) {
                         if ( functionDecl->get_statements() ) {
                                 TyVarMap oldtyVars = scopeTyVars;

src/GenPoly/Box.h ¶

@@ -21 +21 @@
 
 namespace GenPoly {
+        /// boxes polymorphic function calls
         void box( std::list< Declaration* >& translationUnit );
 } // namespace GenPoly

src/GenPoly/CopyParams.h ¶

@@ -20 +20 @@
 
 namespace GenPoly {
+        /// Clones by-value parameters which have been passed by-reference for polymorphism
         void copyParams( std::list< Declaration* > &translationUnit );
 } // namespace GenPoly

src/GenPoly/Lvalue.h ¶

@@ -22 +22 @@
 
 namespace GenPoly {
+        /// replaces return type of `lvalue T` with `T*`, along with appropriate address-of and dereference operators
         void convertLvalue( std::list< Declaration* >& translationUnit );
 } // namespace GenPoly

src/GenPoly/Specialize.h ¶

@@ -22 +22 @@
 
 namespace GenPoly {
+        /// generates thunks where needed
         void convertSpecializations( std::list< Declaration* >& translationUnit );
 } // namespace GenPoly

src/ResolvExpr/Resolver.h ¶

@@ -21 +21 @@
 
 namespace ResolvExpr {
+        /// Checks types and binds syntactic constructs to typed representations
         void resolve( std::list< Declaration * > translationUnit );
         Expression *resolveInVoidContext( Expression *expr, const SymTab::Indexer &indexer );

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 );

src/SynTree/TypeSubstitution.h ¶

@@ -157 +157 @@
 }
 
-// helper function
+/// Instantiate each member of the context given the actual parameters specified, and store the
+/// instantiations for use by the indexer
 template< typename FormalIterator, typename ActualIterator, typename MemberIterator, typename OutputIterator >
 void applySubstitution( FormalIterator formalBegin, FormalIterator formalEnd, ActualIterator actual, MemberIterator memberBegin, MemberIterator memberEnd, OutputIterator out ) {
-        // Instantiate each member of the context given the actual parameters specified, and store the
-        // instantiations for use by the indexer
-
         TypeSubstitution sub = TypeSubstitution( formalBegin, formalEnd, actual );
         for ( std::list< Declaration* >::iterator i = memberBegin; i != memberEnd; ++i ) {