Bug 1960 - Wrong information on index range, about Node::GetDevice
authorTommaso Pecorella <tommaso.pecorella@unifi.it>
Sun, 03 Aug 2014 15:09:19 +0200
changeset 10853 43b9107a69a3
parent 10852 29997008824f
child 10854 e6e590450831
Bug 1960 - Wrong information on index range, about Node::GetDevice
RELEASE_NOTES
src/network/model/node.h
--- a/RELEASE_NOTES	Sun Aug 03 09:55:53 2014 -0700
+++ b/RELEASE_NOTES	Sun Aug 03 15:09:19 2014 +0200
@@ -36,6 +36,7 @@
 - Bug 1943 - Waveform generator signal duration calc error
 - Bug 1951 - AODV does not update nexthop for 1-hop nodes
 - Bug 1955 - The IPv4 identification field should be unique per (source, destination, protocol) tuple
+- Bug 1960 - Wrong information on index range, about Node::GetDevice
 
 Known issues
 ------------
--- a/src/network/model/node.h	Sun Aug 03 09:55:53 2014 -0700
+++ b/src/network/model/node.h	Sun Aug 03 15:09:19 2014 +0200
@@ -84,19 +84,18 @@
   uint32_t GetSystemId (void) const;
 
   /**
+   * \brief Associate a NetDevice to this node.
+   *
    * \param device NetDevice to associate to this node.
    * \returns the index of the NetDevice into the Node's list of
    *          NetDevice.
-   *
-   * Associate this device to this node.
    */
   uint32_t AddDevice (Ptr<NetDevice> device);
   /**
-   * \param index the index of the requested NetDevice
-   * \returns the requested NetDevice associated to this Node.
+   * \brief Retrieve the index-th NetDevice associated to this node.
    *
-   * The indexes used by the GetDevice method start at one and
-   * end at GetNDevices ()
+   * \param index the index of the requested NetDevice
+   * \returns the requested NetDevice.
    */
   Ptr<NetDevice> GetDevice (uint32_t index) const;
   /**
@@ -106,22 +105,23 @@
   uint32_t GetNDevices (void) const;
 
   /**
+   * \brief Associate an Application to this Node.
+   *
    * \param application Application to associate to this node.
    * \returns the index of the Application within the Node's list
    *          of Application.
-   *
-   * Associated this Application to this Node. 
    */
   uint32_t AddApplication (Ptr<Application> application);
   /**
-   * \param index
-   * \returns the application associated to this requested index
-   *          within this Node.
+   * \brief Retrieve the index-th Application associated to this node.
+   *
+   * \param index the index of the requested Application
+   * \returns the requested Application.
    */
   Ptr<Application> GetApplication (uint32_t index) const;
 
   /**
-   * \returns the number of applications associated to this Node.
+   * \returns the number of Application instances associated to this Node.
    */
   uint32_t GetNApplications (void) const;