Doxygen cleanup
authorTom Henderson <tomh@tomh.org>
Mon, 13 Aug 2007 20:53:29 -0700
changeset 1280 8c51afddffcb
parent 1279 03ab1b7ad2d0
child 1281 9b2b6ead9df6
Doxygen cleanup
src/devices/csma/csma-ipv4-topology.h
src/devices/csma/csma-net-device.h
src/devices/point-to-point/point-to-point-net-device.h
src/node/socket.h
src/routing/global-routing/global-router-interface.h
--- a/src/devices/csma/csma-ipv4-topology.h	Sun Aug 12 14:24:49 2007 -0700
+++ b/src/devices/csma/csma-ipv4-topology.h	Mon Aug 13 20:53:29 2007 -0700
@@ -97,7 +97,7 @@
    * \param n1 Node
    * \param ndNum NetDevice number with which to associate address
    * \param addr1 Ipv4 Address for ndNum of n1
-   * \param network network mask for ndNum of node n1
+   * \param netmask1 network mask for ndNum of node n1
    * 
    * Add an Ipv4Address to the Ipv4 interface associated with the
    * ndNum CsmaIpv4NetDevices on the provided
--- a/src/devices/csma/csma-net-device.h	Sun Aug 12 14:24:49 2007 -0700
+++ b/src/devices/csma/csma-net-device.h	Mon Aug 13 20:53:29 2007 -0700
@@ -99,8 +99,23 @@
    *
    * \param node the Node to which this device is connected.
    * \param addr The source MAC address of the net device.
+   * \param pktType the type of encapsulation
    */
   CsmaNetDevice (Ptr<Node> node, Eui48Address addr, CsmaEncapsulationMode pktType);
+
+  /**
+   * Construct a CsmaNetDevice
+   *
+   * This is the constructor for the CsmaNetDevice.  It takes as a
+   * parameter the Node to which this device is connected.  Ownership of the
+   * Node pointer is not implied and the node must not be deleted.
+   *
+   * \param node the Node to which this device is connected.
+   * \param addr The source MAC address of the net device.
+   * \param pktType the type of encapsulation
+   * \param sendEnable whether this device is able to send
+   * \param receiveEnable whether this device is able to receive
+   */
   CsmaNetDevice (Ptr<Node> node, Eui48Address addr,
                    CsmaEncapsulationMode pktType,
                    bool sendEnable, bool receiveEnable);
--- a/src/devices/point-to-point/point-to-point-net-device.h	Sun Aug 12 14:24:49 2007 -0700
+++ b/src/devices/point-to-point/point-to-point-net-device.h	Mon Aug 13 20:53:29 2007 -0700
@@ -175,7 +175,6 @@
   virtual Ptr<Channel> DoGetChannel(void) const;
   /**
    * Set a new default data rate
-   * @param Data rate to set for new default
    */
   static void SetDefaultRate(const DataRate&);
 
--- a/src/node/socket.h	Sun Aug 12 14:24:49 2007 -0700
+++ b/src/node/socket.h	Mon Aug 13 20:53:29 2007 -0700
@@ -170,7 +170,6 @@
   /**
    * \brief Send data (or dummy data) to the remote host
    * \param p packet to send
-   * \param dataSent Data sent callback.
    * \returns -1 in case of error or the number of bytes copied in the 
    *          internal buffer and accepted for transmission.
    */
@@ -180,7 +179,6 @@
    * \brief Send data to a specified peer.
    * \param address IP Address of remote host
    * \param p packet to send
-   * \param dataSent Data sent callback.
    * \returns -1 in case of error or the number of bytes copied in the 
    *          internal buffer and accepted for transmission.
    */
--- a/src/routing/global-routing/global-router-interface.h	Sun Aug 12 14:24:49 2007 -0700
+++ b/src/routing/global-routing/global-router-interface.h	Mon Aug 13 20:53:29 2007 -0700
@@ -431,7 +431,7 @@
 /**
  * @brief Add an attached router to the list in the NetworkLSA
  *
- * @param address The Ipv4Address of the interface on the network link
+ * @param addr The Ipv4Address of the interface on the network link
  * @returns The number of addresses in the list.
  */
   uint32_t AddAttachedRouter (Ipv4Address addr);