[Doxygen] Minor fix-ups
authorPeter D. Barnes, Jr. <barnes26@llnl.gov>
Wed, 08 Oct 2014 11:59:31 -0700
changeset 10991 54d908f84801
parent 10990 414d94e669c5
child 10992 1c1b8814895e
[Doxygen] Minor fix-ups
doc/manual/source/documentation.rst
src/internet/model/tcp-header.h
src/lte/model/lte-asn1-header.h
src/network/model/net-device.h
src/nix-vector-routing/helper/ipv4-nix-vector-helper.h
src/olsr/helper/olsr-helper.h
src/point-to-point/model/point-to-point-channel.h
src/point-to-point/model/point-to-point-net-device.h
--- a/doc/manual/source/documentation.rst	Tue Oct 07 12:19:52 2014 -0700
+++ b/doc/manual/source/documentation.rst	Wed Oct 08 11:59:31 2014 -0700
@@ -476,7 +476,7 @@
    src/mesh/helper/dot11s/dot11s-installer.h:72: warning: Member m_root (variable) of class ns3::Dot11sStack is not documented.
    src/mesh/helper/dot11s/dot11s-installer.h:35: warning: return type of member ns3::Dot11sStack::GetTypeId is not documented
    src/mesh/helper/dot11s/dot11s-installer.h:56: warning: return type of member ns3::Dot11sStack::InstallStack is not documented
-   src/mesh/helper/flame/flame-installer.h:40: warning: Member GetTypeId() (function) of class ns3::FlameStack is not documented.
+   src/mesh/helper/flame/lfame-installer.h:40: warning: Member GetTypeId() (function) of class ns3::FlameStack is not documented.
    src/mesh/helper/flame/flame-installer.h:60: warning: return type of member ns3::FlameStack::InstallStack is not documented
    src/mesh/helper/mesh-helper.h:213: warning: Member m_nInterfaces (variable) of class ns3::MeshHelper is not documented.
    src/mesh/helper/mesh-helper.h:214: warning: Member m_spreadChannelPolicy (variable) of class ns3::MeshHelper is not documented.
@@ -519,6 +519,16 @@
     */
     class Foo
 
+* Did you know ``typedef``s can have formal arguments?  This enables
+  documentation of function pointer signatures::
+
+    /**
+     * Bar callback function signature.
+     *
+     * \param ale The size of a pint of ale, in Imperial ounces.
+     */
+    typedef void (* BarCallback)(const int ale);
+    
 * Copy the ``Attribute`` help strings from the ``GetTypeId`` method to use
   as the brief descriptions of associated members.
 
--- a/src/internet/model/tcp-header.h	Tue Oct 07 12:19:52 2014 -0700
+++ b/src/internet/model/tcp-header.h	Wed Oct 08 11:59:31 2014 -0700
@@ -169,7 +169,7 @@
   /**
    * \brief Append an option to the TCP header
    * \param option The option to append
-   * \return true if optionhas been appended, false otherwise
+   * \return true if option has been appended, false otherwise
    */
   bool AppendOption (Ptr<TcpOption> option);
 
--- a/src/lte/model/lte-asn1-header.h	Tue Oct 07 12:19:52 2014 -0700
+++ b/src/lte/model/lte-asn1-header.h	Wed Oct 08 11:59:31 2014 -0700
@@ -54,12 +54,13 @@
   virtual void Print (std::ostream &os) const = 0;
     
   /**
-   * This function serializes class attributes to m_serializationResult local Buffer.
-   * As ASN1 encoding produces a bitstream that does not have a fixed length,
-   * this function is needed to store the result, so its length can be retrieved
-   * with Header::GetSerializedSize() function.
-   * This method is pure virtual in this class (needs to be implemented in child classes)
-   * as the meaningful information elements are in the subclasses.
+   * This function serializes class attributes to m_serializationResult
+   * local Buffer.  As ASN1 encoding produces a bitstream that does not have
+   * a fixed length, this function is needed to store the result, so
+   * its length can be retrieved with Header::GetSerializedSize() function.
+   * This method is pure virtual in this class (needs to be implemented
+   * in child classes) as the meaningful information elements are in
+   * the subclasses.
    */
   virtual void PreSerialize (void) const = 0;
 
@@ -103,7 +104,8 @@
    * \param selectedOption selected option
    * \param isExtensionMarkerPresent true if extension mark is present
    */
-  void SerializeChoice (int numOptions, int selectedOption, bool isExtensionMarkerPresent) const;
+  void SerializeChoice (int numOptions, int selectedOption,
+                        bool isExtensionMarkerPresent) const;
   /**
    * Serialize an Enum
    * \param numElems number of elements in the enum
@@ -132,67 +134,78 @@
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
   template <int N>
-  void SerializeSequence (std::bitset<N> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<N> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<0> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<0> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<1> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<1> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<2> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<2> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<3> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<3> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<4> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<4> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<5> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<5> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<6> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<6> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<9> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<9> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<10> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<10> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
   /**
    * Serialize a sequence
    * \param optionalOrDefaultMask Mask to serialize
    * \param isExtensionMarkerPresent true if Extension Marker is present
    */
-  void SerializeSequence (std::bitset<11> optionalOrDefaultMask, bool isExtensionMarkerPresent) const;
+  void SerializeSequence (std::bitset<11> optionalOrDefaultMask,
+                          bool isExtensionMarkerPresent) const;
 
   /**
    * Serialize a bitstring
@@ -250,14 +263,16 @@
    * \returns the modified buffer iterator
    */
   template <int N>
-  Buffer::Iterator DeserializeBitset (std::bitset<N> *data, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitset (std::bitset<N> *data,
+                                      Buffer::Iterator bIterator);
   /**
    * Deserialize a bitset
    * \param data buffer to store the result
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeBitset (std::bitset<8> *data, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitset (std::bitset<8> *data,
+                                      Buffer::Iterator bIterator);
 
   /**
    * Deserialize a boolean
@@ -265,7 +280,8 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeBoolean (bool *value, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBoolean (bool *value,
+                                       Buffer::Iterator bIterator);
   /**
    * Deserialize an integer
    * \param n buffer to store the result
@@ -274,7 +290,8 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeInteger (int *n, int nmin, int nmax, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeInteger (int *n, int nmin, int nmax,
+                                       Buffer::Iterator bIterator);
   /**
    * Deserialize a Choice (set of options)
    * \param numOptions number of options
@@ -283,7 +300,10 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeChoice (int numOptions, bool isExtensionMarkerPresent, int *selectedOption, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeChoice (int numOptions,
+                                      bool isExtensionMarkerPresent,
+                                      int *selectedOption,
+                                      Buffer::Iterator bIterator);
   /**
    * Deserialize an Enum
    * \param numElems number of elements in the enum
@@ -291,7 +311,8 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeEnum (int numElems, int *selectedElem, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeEnum (int numElems, int *selectedElem,
+                                    Buffer::Iterator bIterator);
 
   /**
    * Deserialize a sequence
@@ -308,7 +329,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<N> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<N> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -316,7 +339,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<0> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<0> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -324,7 +349,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<1> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<1> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -332,7 +359,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<2> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<2> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -340,7 +369,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<3> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<3> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -348,7 +379,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<4> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<4> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -356,7 +389,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<5> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<5> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -364,7 +399,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<6> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<6> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -372,7 +409,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<9> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<9> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -380,7 +419,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<10> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<10> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
   /**
    * Deserialize a sequence
    * \param optionalOrDefaultMask buffer to store the result
@@ -388,7 +429,9 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequence (std::bitset<11> *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequence (std::bitset<11> *optionalOrDefaultMask,
+                                        bool isExtensionMarkerPresent,
+                                        Buffer::Iterator bIterator);
 
   /**
    * Deserialize a bitstring
@@ -397,63 +440,72 @@
    * \returns the modified buffer iterator
    */
  template <int N>
-  Buffer::Iterator DeserializeBitstring (std::bitset<N> *bitstring, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitstring (std::bitset<N> *bitstring,
+                                         Buffer::Iterator bIterator);
  /**
   * Deserialize a bitstring
   * \param bitstring buffer to store the result
   * \param bIterator buffer iterator
   * \returns the modified buffer iterator
   */
-  Buffer::Iterator DeserializeBitstring (std::bitset<1> *bitstring, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitstring (std::bitset<1> *bitstring,
+                                         Buffer::Iterator bIterator);
   /**
    * Deserialize a bitstring
    * \param bitstring buffer to store the result
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeBitstring (std::bitset<2> *bitstring, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitstring (std::bitset<2> *bitstring,
+                                         Buffer::Iterator bIterator);
   /**
    * Deserialize a bitstring
    * \param bitstring buffer to store the result
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeBitstring (std::bitset<8> *bitstring, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitstring (std::bitset<8> *bitstring,
+                                         Buffer::Iterator bIterator);
   /**
    * Deserialize a bitstring
    * \param bitstring buffer to store the result
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeBitstring (std::bitset<10> *bitstring, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitstring (std::bitset<10> *bitstring,
+                                         Buffer::Iterator bIterator);
   /**
    * Deserialize a bitstring
    * \param bitstring buffer to store the result
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeBitstring (std::bitset<16> *bitstring, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitstring (std::bitset<16> *bitstring,
+                                         Buffer::Iterator bIterator);
   /**
    * Deserialize a bitstring
    * \param bitstring buffer to store the result
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeBitstring (std::bitset<27> *bitstring, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitstring (std::bitset<27> *bitstring,
+                                         Buffer::Iterator bIterator);
   /**
    * Deserialize a bitstring
    * \param bitstring buffer to store the result
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeBitstring (std::bitset<28> *bitstring, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitstring (std::bitset<28> *bitstring,
+                                         Buffer::Iterator bIterator);
   /**
    * Deserialize a bitstring
    * \param bitstring buffer to store the result
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeBitstring (std::bitset<32> *bitstring, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeBitstring (std::bitset<32> *bitstring,
+                                         Buffer::Iterator bIterator);
 
   /**
    * Deserialize nothing (null op)
@@ -469,7 +521,8 @@
    * \param bIterator buffer iterator
    * \returns the modified buffer iterator
    */
-  Buffer::Iterator DeserializeSequenceOf (int *numElems, int nMax, int nMin, Buffer::Iterator bIterator);
+  Buffer::Iterator DeserializeSequenceOf (int *numElems, int nMax, int nMin,
+                                          Buffer::Iterator bIterator);
 };
 
 } // namespace ns3
--- a/src/network/model/net-device.h	Tue Oct 07 12:19:52 2014 -0700
+++ b/src/network/model/net-device.h	Wed Oct 08 11:59:31 2014 -0700
@@ -183,9 +183,7 @@
    * multicast group.
    *
    * \warning Calling this method is invalid if IsMulticast returns not true.
-   * \see Ipv4Address
-   * \see Address
-   * \see NetDevice::IsMulticast
+   * \see IsMulticast()
    */
   virtual Address GetMulticast (Ipv4Address multicastGroup) const = 0;
 
--- a/src/nix-vector-routing/helper/ipv4-nix-vector-helper.h	Tue Oct 07 12:19:52 2014 -0700
+++ b/src/nix-vector-routing/helper/ipv4-nix-vector-helper.h	Wed Oct 08 11:59:31 2014 -0700
@@ -70,7 +70,6 @@
    * \internal
    * \brief Assignment operator declared private and not implemented to disallow
    * assignment and prevent the compiler from happily inserting its own.
-   * \returns
    */
   Ipv4NixVectorHelper &operator = (const Ipv4NixVectorHelper &);
 
--- a/src/olsr/helper/olsr-helper.h	Tue Oct 07 12:19:52 2014 -0700
+++ b/src/olsr/helper/olsr-helper.h	Wed Oct 08 11:59:31 2014 -0700
@@ -101,7 +101,6 @@
    * \internal
    * \brief Assignment operator declared private and not implemented to disallow
    * assignment and prevent the compiler from happily inserting its own.
-   * \returns
    */
   OlsrHelper &operator = (const OlsrHelper &);
   ObjectFactory m_agentFactory; //!< Object factory
--- a/src/point-to-point/model/point-to-point-channel.h	Tue Oct 07 12:19:52 2014 -0700
+++ b/src/point-to-point/model/point-to-point-channel.h	Wed Oct 08 11:59:31 2014 -0700
@@ -60,7 +60,7 @@
   /**
    * \brief Create a PointToPointChannel
    *
-   * By default, you get a channel that has an "infitely" fast 
+   * By default, you get a channel that has an "infinitely" fast 
    * transmission speed and zero delay.
    */
   PointToPointChannel ();
@@ -130,8 +130,8 @@
   Ptr<PointToPointNetDevice> GetDestination (uint32_t i) const;
 
 private:
-  static const int N_DEVICES = 2; //!< Each point to point link has
-                                  //   exactly two net devices
+  /** Each point to point link has exactly two net devices. */
+  static const int N_DEVICES = 2; 
 
   Time          m_delay;    //!< Propagation delay
   int32_t       m_nDevices; //!< Devices of this channel
@@ -157,12 +157,14 @@
    */
   enum WireState
   {
-    INITIALIZING, //!< Initializing state
-    IDLE,         //!< Idle state (no transmission from NetDevice)
-    TRANSMITTING, //!< Transmitting state (data being transmitted from
-                  //   NetDevice
-    PROPAGATING   //!< Propagating state (data is being propagated in the
-                  //   channel
+    /** Initializing state */
+    INITIALIZING,
+    /** Idle state (no transmission from NetDevice) */
+    IDLE,
+    /** Transmitting state (data being transmitted from NetDevice. */
+    TRANSMITTING, 
+    /** Propagating state (data is being propagated in the channel. */
+    PROPAGATING   
   };
 
   /**
--- a/src/point-to-point/model/point-to-point-net-device.h	Tue Oct 07 12:19:52 2014 -0700
+++ b/src/point-to-point/model/point-to-point-net-device.h	Wed Oct 08 11:59:31 2014 -0700
@@ -58,11 +58,6 @@
  * Key parameters or objects that can be specified for this device 
  * include a queue, data rate, and interframe transmission gap (the 
  * propagation delay is set in the PointToPointChannel).
- *
- * \see SetDataRate
- * \see SetInterframeGap
- * \see SetReceiveErrorModel
- *
  */
 class PointToPointNetDevice : public NetDevice
 {
@@ -92,10 +87,9 @@
 
   /**
    * Set the Data Rate used for transmission of packets.  The data rate is
-   * set in the Attach () method from the corresponding field in the channel
+   * set in the Attach() method from the corresponding field in the channel
    * to which the device is attached.  It can be overridden using this method.
    *
-   * \see Attach ()
    * \param bps the data rate at which this object operates
    */
   void SetDataRate (DataRate bps);
@@ -120,10 +114,8 @@
    * Attach a queue to the PointToPointNetDevice.
    *
    * The PointToPointNetDevice "owns" a queue that implements a queueing 
-   * method such as DropTail or RED.
+   * method such as DropTailQueue or RedQueue
    *
-   * \see Queue
-   * \see DropTailQueue
    * \param queue Ptr to the new queue.
    */
   void SetQueue (Ptr<Queue> queue);
@@ -141,7 +133,6 @@
    * The PointToPointNetDevice may optionally include an ErrorModel in
    * the packet receive chain.
    *
-   * \see ErrorModel
    * \param em Ptr to the ErrorModel.
    */
   void SetReceiveErrorModel (Ptr<ErrorModel> em);
@@ -154,7 +145,6 @@
    * used by the channel to indicate that the last bit of a packet has 
    * arrived at the device.
    *
-   * \see PointToPointChannel
    * \param p Ptr to the received packet.
    */
   void Receive (Ptr<Packet> p);
@@ -271,7 +261,7 @@
    * the bits have been completely transmitted.
    *
    * \see PointToPointChannel::TransmitStart ()
-   * \see TransmitCompleteEvent ()
+   * \see TransmitComplete()
    * \param p a reference to the packet to send
    * \returns true if success, false on failure
    */
@@ -302,28 +292,24 @@
   };
   /**
    * The state of the Net Device transmit state machine.
-   * \see TxMachineState
    */
   TxMachineState m_txMachineState;
 
   /**
    * The data rate that the Net Device uses to simulate packet transmission
    * timing.
-   * \see class DataRate
    */
   DataRate       m_bps;
 
   /**
    * The interframe gap that the Net Device uses to throttle packet
    * transmission
-   * \see class Time
    */
   Time           m_tInterframeGap;
 
   /**
    * The PointToPointChannel to which this PointToPointNetDevice has been
    * attached.
-   * \see class PointToPointChannel
    */
   Ptr<PointToPointChannel> m_channel;
 
@@ -331,7 +317,6 @@
    * The Queue which this PointToPointNetDevice uses as a packet source.
    * Management of this Queue has been delegated to the PointToPointNetDevice
    * and it has the responsibility for deletion.
-   * \see class Queue
    * \see class DropTailQueue
    */
   Ptr<Queue> m_queue;
@@ -344,16 +329,12 @@
   /**
    * The trace source fired when packets come into the "top" of the device
    * at the L3/L2 transition, before being queued for transmission.
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_macTxTrace;
 
   /**
    * The trace source fired when packets coming into the "top" of the device
    * at the L3/L2 transition are dropped before being queued for transmission.
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_macTxDropTrace;
 
@@ -362,8 +343,6 @@
    * immediately before being forwarded up to higher layers (at the L2/L3 
    * transition).  This is a promiscuous trace (which doesn't mean a lot here
    * in the point-to-point device).
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_macPromiscRxTrace;
 
@@ -372,8 +351,6 @@
    * immediately before being forwarded up to higher layers (at the L2/L3 
    * transition).  This is a non-promiscuous trace (which doesn't mean a lot 
    * here in the point-to-point device).
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_macRxTrace;
 
@@ -381,48 +358,36 @@
    * The trace source fired for packets successfully received by the device
    * but are dropped before being forwarded up to higher layers (at the L2/L3 
    * transition).
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_macRxDropTrace;
 
   /**
    * The trace source fired when a packet begins the transmission process on
    * the medium.
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_phyTxBeginTrace;
 
   /**
    * The trace source fired when a packet ends the transmission process on
    * the medium.
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_phyTxEndTrace;
 
   /**
    * The trace source fired when the phy layer drops a packet before it tries
    * to transmit it.
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_phyTxDropTrace;
 
   /**
    * The trace source fired when a packet begins the reception process from
    * the medium -- when the simulated first bit(s) arrive.
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_phyRxBeginTrace;
 
   /**
    * The trace source fired when a packet ends the reception process from
    * the medium.
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_phyRxEndTrace;
 
@@ -430,8 +395,6 @@
    * The trace source fired when the phy layer drops a packet it has received.
    * This happens if the receiver is not enabled or the error model is active
    * and indicates that the packet is corrupt.
-   *
-   * \see class CallBackTraceSource
    */
   TracedCallback<Ptr<const Packet> > m_phyRxDropTrace;
 
@@ -442,16 +405,14 @@
    *
    * On the transmit size, this trace hook will fire after a packet is dequeued
    * from the device queue for transmission.  In Linux, for example, this would
-   * correspond to the point just before a device hard_start_xmit where 
-   * dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET 
+   * correspond to the point just before a device \c hard_start_xmit where 
+   * \c dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET 
    * ETH_P_ALL handlers.
    *
    * On the receive side, this trace hook will fire when a packet is received,
    * just before the receive callback is executed.  In Linux, for example, 
    * this would correspond to the point at which the packet is dispatched to 
-   * packet sniffers in netif_receive_skb.
-   *
-   * \see class CallBackTraceSource
+   * packet sniffers in \c netif_receive_skb.
    */
   TracedCallback<Ptr<const Packet> > m_snifferTrace;
 
@@ -462,21 +423,19 @@
    *
    * On the transmit size, this trace hook will fire after a packet is dequeued
    * from the device queue for transmission.  In Linux, for example, this would
-   * correspond to the point just before a device hard_start_xmit where 
-   * dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET 
+   * correspond to the point just before a device \c hard_start_xmit where 
+   * \c dev_queue_xmit_nit is called to dispatch the packet to the PF_PACKET 
    * ETH_P_ALL handlers.
    *
    * On the receive side, this trace hook will fire when a packet is received,
    * just before the receive callback is executed.  In Linux, for example, 
    * this would correspond to the point at which the packet is dispatched to 
-   * packet sniffers in netif_receive_skb.
-   *
-   * \see class CallBackTraceSource
+   * packet sniffers in \c netif_receive_skb.
    */
   TracedCallback<Ptr<const Packet> > m_promiscSnifferTrace;
 
   Ptr<Node> m_node;         //!< Node owning this NetDevice
-  Mac48Address m_address;   //!< Address of this NetDevice
+  Mac48Address m_address;   //!< Mac48Address of this NetDevice
   NetDevice::ReceiveCallback m_rxCallback;   //!< Receive callback
   NetDevice::PromiscReceiveCallback m_promiscCallback;  //!< Receive callback
                                                         //   (promisc data)