improve the doxygen output.
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Thu, 17 Apr 2008 14:15:33 -0700
changeset 2967 6fe0a5622af7
parent 2966 0116649f03f8
child 2968 d6b2d00acab2
improve the doxygen output.
src/core/enum.cc
src/core/object-vector.h
--- a/src/core/enum.cc	Thu Apr 17 14:13:27 2008 -0700
+++ b/src/core/enum.cc	Thu Apr 17 14:15:33 2008 -0700
@@ -111,7 +111,7 @@
 std::string 
 EnumChecker::GetType (void) const
 {
-  return "Enum";
+  return "EnumValue";
 }
 bool 
 EnumChecker::HasTypeConstraints (void) const
--- a/src/core/object-vector.h	Thu Apr 17 14:13:27 2008 -0700
+++ b/src/core/object-vector.h	Thu Apr 17 14:15:33 2008 -0700
@@ -21,9 +21,22 @@
 
   ObjectVectorValue ();
 
+  /**
+   * \returns an iterator to the first object contained in this vector
+   */
   Iterator Begin (void) const;
+  /**
+   * \returns an iterator to the last object contained in this vector
+   */
   Iterator End (void) const;
+  /**
+   * \returns the number of objects contained in this vector.
+   */
   uint32_t GetN (void) const;
+  /**
+   * \param i the index of the requested object.
+   * \returns the requested object
+   */
   Ptr<Object> Get (uint32_t i) const;
 
   virtual Ptr<AttributeValue> Copy (void) const;
@@ -75,7 +88,7 @@
     return dynamic_cast<const ObjectVectorValue *> (&value) != 0;
   }
   virtual std::string GetType (void) const {
-    return "ns3::ObjectVector";
+    return "ns3::ObjectVectorValue";
   }
   virtual bool HasTypeConstraints (void) const {
     return true;