add documentation

Geode-solutions · Apr 1, 2020 · 271c0d6 · 271c0d6
1 parent cb007e9
commit 271c0d6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/include/geode/basic/attribute_manager.h b/include/geode/basic/attribute_manager.h
@@ -92,7 +92,8 @@ namespace geode
          * @param[in] name The associated attribute name to look for
          * @param[in] default_value The default value to use when new attribute
          * element are created
-         * @param[in] properties The AttributeProperties to use
+         * @param[in] properties The AttributeProperties to set the attribute
+         * flags for future modifications
          * @tparam Attribute The attribute type to look for,
          * such as ConstantAttribute
          * @tparam T The type of the Attribute element

diff --git a/include/geode/basic/attribute_utils.h b/include/geode/basic/attribute_utils.h
@@ -48,6 +48,10 @@ namespace geode
 
 namespace geode
 {
+    /*!
+     * Struct holding Attribute flags used by the AttributeManager for
+     * updating/computing attribute values
+     */
     struct AttributeProperties
     {
         AttributeProperties() = default;