add doxygen
authorTom Henderson <tomh@tomh.org>
Mon, 06 Oct 2014 16:32:44 -0700
changeset 10984 f20ec8fcc676
parent 10983 087597a150da
child 10985 be88b29e4089
add doxygen
src/core/helper/event-garbage-collector.h
src/core/model/attribute-accessor-helper.h
src/core/model/attribute.h
--- a/src/core/helper/event-garbage-collector.h	Mon Oct 06 16:05:46 2014 -0700
+++ b/src/core/helper/event-garbage-collector.h	Mon Oct 06 16:32:44 2014 -0700
@@ -49,22 +49,39 @@
   ~EventGarbageCollector ();
 
 private:
-
+ 
+  /**
+   * \brief comparison operator for std::multiset
+   */
   struct EventIdLessThanTs
   {
+    /**
+     * \brief comparison operator for std::multiset
+     */
     bool operator () (const EventId &a, const EventId &b) const
     {
       return (a.GetTs () < b.GetTs ());
     }
   };
 
+  /** Event list container */
   typedef std::multiset<EventId, EventIdLessThanTs> EventList;
 
-  EventList::size_type m_nextCleanupSize;
-  EventList m_events;
+  EventList::size_type m_nextCleanupSize;      //!< batch size for cleanup
+  EventList m_events;                          //!< the tracked event list 
 
+  /**
+   * \brief called when a new event was added and the cleanup limit was
+   * exceeded in consequence.
+   */
   void Cleanup ();
+  /**
+   * \brief grow the cleanup limit
+   */
   void Grow ();
+  /**
+   * \brief shrink the cleanup limit
+   */
   void Shrink ();
 };
 
--- a/src/core/model/attribute-accessor-helper.h	Mon Oct 06 16:05:46 2014 -0700
+++ b/src/core/model/attribute-accessor-helper.h	Mon Oct 06 16:32:44 2014 -0700
@@ -50,12 +50,18 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup AttributeHelper
+ */
 template <typename T>
 struct AccessorTrait
 {
   typedef typename TypeTraits<typename TypeTraits<T>::ReferencedType>::NonConstType Result;
 };
 
+/**
+ * \ingroup AttributeHelper
+ */
 template <typename T, typename U>
 class AccessorHelper : public AttributeAccessor
 {
--- a/src/core/model/attribute.h	Mon Oct 06 16:05:46 2014 -0700
+++ b/src/core/model/attribute.h	Mon Oct 06 16:32:44 2014 -0700
@@ -224,8 +224,25 @@
 public:
   EmptyAttributeValue ();
 private:
+  /**
+   * \returns a deep copy of this class, wrapped into an Attribute object.
+   */
   virtual Ptr<AttributeValue> Copy (void) const;
+  /**
+   * \param checker the checker associated to the attribute
+   * \returns a string representation of this value.
+   *
+   * In the EmptyAttributeValue case, the string returned will be simply ""
+   */
   virtual std::string SerializeToString (Ptr<const AttributeChecker> checker) const;
+  /**
+   * \param value a string representation of the value
+   * \param checker a pointer to the checker associated to the attribute.
+   * \returns true if the input string was correctly-formatted and could be
+   *          successfully deserialized, false otherwise.
+   *
+   * In the trivial case of EmptyAttributeValue, this should always return true
+   */
   virtual bool DeserializeFromString (std::string value, Ptr<const AttributeChecker> checker);
 };