src/core/model/attribute.h
changeset 9969 e813ecb3613d
parent 7399 520706f801e8
child 10984 f20ec8fcc676
--- a/src/core/model/attribute.h	Wed Jul 24 16:42:51 2013 -0700
+++ b/src/core/model/attribute.h	Wed Jul 24 17:03:28 2013 -0700
@@ -35,7 +35,12 @@
 /**
  *
  * \ingroup core
- * \defgroup attribute Attribute
+ * \defgroup attribute Attributes
+ *
+ * The \c ns-3 attribute system is the mechanism used in \c ns-3 to
+ * organize, document, and modify the *values* used by the various
+ * component models.  Attributes also enable the tracing and statistics
+ * gathering in the simulator.
  */
 
 /**
@@ -152,6 +157,13 @@
   AttributeChecker ();
   virtual ~AttributeChecker ();
 
+  /**
+   * Create a valid value from the argument value,
+   * or reinterpret the argument as a string.
+   *
+   * \param value the AttributeValue to check
+   * \return Ptr to a valid value
+   */
   Ptr<AttributeValue> CreateValidValue (const AttributeValue &value) const;
   /**
    * \param value a pointer to the value to check
@@ -190,7 +202,13 @@
    * to calling Attribute::DeserializeFromString.
    */
   virtual Ptr<AttributeValue> Create (void) const = 0;
+  /**
+   * Copy the source to the destination
 
+   * \param source source AttributeValue
+   * \param destination destination AttributeValue
+   * \return true if copy was successful
+   */
   virtual bool Copy (const AttributeValue &source, AttributeValue &destination) const = 0;