src/core/model/pointer.h
changeset 11036 1e03af4311bd
parent 7169 358f71a624d8
child 11136 03bf8fa63bda
--- a/src/core/model/pointer.h	Tue Oct 21 12:21:13 2014 -0700
+++ b/src/core/model/pointer.h	Tue Oct 21 16:14:35 2014 -0700
@@ -25,36 +25,55 @@
 
 namespace ns3 {
 
-/**
- * \ingroup attribute
- *
- * \brief hold objects of type Ptr<T>
- */
+//  Additional docs for class PointerValue:
+/** Hold objects of type Ptr<T>. */
 class PointerValue : public AttributeValue
 {
 public:
   PointerValue ();
-
+  
+  /**
+   * Construct this PointerValue by referencing an explicit Object.
+   *
+   * \param [in] object The object to begin with.
+   */
   PointerValue (Ptr<Object> object);
 
+  /**
+   * Set the value from by reference an Object.
+   *
+   * \param [in] object The object to reference.
+   */
   void SetObject (Ptr<Object> object);
 
+  /**
+   * Get the Object referenced by the PointerValue.
+   * \returns The Object.
+   */
   Ptr<Object> GetObject (void) const;
 
+  /**
+   * Construct this PointerValue by referencing an explicit Object.
+   *
+   * \tparam T (implicit) The type of the object.
+   * \param [in] object The object to begin with.
+   */
   template <typename T>
-  PointerValue (const Ptr<T> &object);
+  PointerValue (const Ptr<T> & object);
 
+  /** Cast to an Object of type \c T. */ 
   template <typename T>
-  void Set (const Ptr<T> &object);
+  operator Ptr<T> () const;
+
+  // Documentation generated by print-introspected-doxygen.cc
+  template <typename T>
+  void Set (const Ptr<T> & value);
 
   template <typename T>
   Ptr<T> Get (void) const;
 
   template <typename T>
-  bool GetAccessor (Ptr<T> &v) const;
-
-  template <typename T>
-  operator Ptr<T> () const;
+  bool GetAccessor (Ptr<T> &value) const;
 
   virtual Ptr<AttributeValue> Copy (void) const;
   virtual std::string SerializeToString (Ptr<const AttributeChecker> checker) const;
@@ -68,6 +87,11 @@
 class PointerChecker : public AttributeChecker 
 {
 public:
+
+  /**
+   * Get the TypeId of the base type.
+   * \returns The base TypeId.
+   */
   virtual TypeId GetPointeeTypeId (void) const = 0;
 };
 template <typename T>
@@ -80,8 +104,9 @@
 
 namespace internal {
 
+/** PointerChecker implementation. */
 template <typename T>
-class APointerChecker : public PointerChecker
+class PointerChecker : public ns3::PointerChecker
 {
   virtual bool Check (const AttributeValue &val) const {
     const PointerValue *value = dynamic_cast<const PointerValue *> (&val);
@@ -177,7 +202,7 @@
 Ptr<AttributeChecker>
 MakePointerChecker (void)
 {
-  return Create<internal::APointerChecker<T> > ();
+  return Create<internal::PointerChecker<T> > ();
 }