Changeset 8c91088

Timestamp:

Oct 6, 2022, 4:00:41 PM (2 years ago)

Author:

Andrew Beach <ajbeach@…>

Branches:

ADT, ast-experimental, master

Children:

c8837e5

Parents:

7fffb1b

Message:

Slight improvement to documentation in Box.cc.

File:

• src/GenPoly/Box.cc (modified) (4 diffs)

src/GenPoly/Box.cc

@@ -66 +66 @@
                 };
 
-                /// Adds layout-generation functions to polymorphic types
+                /// Adds layout-generation functions to polymorphic types.
                 class LayoutFunctionBuilder final : public WithDeclsToAdd, public WithVisitorRef<LayoutFunctionBuilder>, public WithShortCircuiting {
-                        unsigned int functionNesting = 0;  // current level of nested functions
+                        // Current level of nested functions:
+                        unsigned int functionNesting = 0;
                 public:
                         void previsit( FunctionDecl *functionDecl );
@@ -75 +76 @@
                 };
 
-                /// Replaces polymorphic return types with out-parameters, replaces calls to polymorphic functions with adapter calls as needed, and adds appropriate type variables to the function call
+                /// Replaces polymorphic return types with out-parameters,
+                /// replaces calls to polymorphic functions with adapter calls,
+                /// and adds appropriate type variables to the function call.
                 class Pass1 final : public BoxPass, public WithConstTypeSubstitution, public WithStmtsToAdd, public WithGuards, public WithVisitorRef<Pass1>, public WithShortCircuiting {
                   public:
@@ -146 +149 @@
                 };
 
-                /// Replaces member and size/align/offsetof expressions on polymorphic generic types with calculated expressions.
+                /// * Replaces member and size/align/offsetof expressions on polymorphic generic types with calculated expressions.
                 /// * Replaces member expressions for polymorphic types with calculated add-field-offset-and-dereference
                 /// * Calculates polymorphic offsetof expressions from offset array
@@ -199 +202 @@
                 };
 
-                /// Replaces initialization of polymorphic values with alloca, declaration of dtype/ftype with appropriate void expression, sizeof expressions of polymorphic types with the proper variable, and strips fields from generic struct declarations.
+                /// Replaces initialization of polymorphic values with alloca,
+                /// declaration of dtype/ftype with appropriate void expression,
+                /// sizeof expressions of polymorphic types with the proper variable,
+                /// and strips fields from generic struct declarations.
                 struct Pass3 final : public BoxPass, public WithGuards {
                         template< typename DeclClass >