internet: doxygen fixes

src/internet/model/global-router-interface.h

@@ -847,6 +847,9 @@ private:
 
   // Declared mutable so that const member functions can clear it
   // (supporting the logical constness of the search methods of this class) 
+  /**
+   * Container of bridges visited.
+   */
   mutable std::vector<Ptr<BridgeNetDevice> > m_bridgesVisited;
   /**
    * Clear the list of bridges visited on the link 

src/internet/model/ipv4-global-routing.h

@@ -258,6 +258,12 @@ private:
   /// iterator of container of Ipv4RoutingTableEntry (routes to external AS)
   typedef std::list<Ipv4RoutingTableEntry *>::iterator ASExternalRoutesI;
 
+  /**
+   * \brief Lookup in the forwarding table for destination.
+   * \param dest destination address
+   * \param oif output interface if any (put 0 otherwise)
+   * \return Ipv4Route to route the packet to reach dest address
+   */
   Ptr<Ipv4Route> LookupGlobal (Ipv4Address dest, Ptr<NetDevice> oif = 0);
 
   HostRoutes m_hostRoutes;             //!< Routes to hosts

src/internet/model/ipv4-l3-protocol.h

@@ -394,11 +394,11 @@ private:
   /**
    * \brief Fragment a packet
    * \param packet the packet
-   * \param ipHeader the IPv4 header
+   * \param ipv4Header the IPv4 header
    * \param outIfaceMtu the MTU of the interface
    * \param listFragments the list of fragments
    */
-  void DoFragmentation (Ptr<Packet> packet, const Ipv4Header & ipv4Header, uint32_t outIfaceMtu, std::list<Ipv4PayloadHeaderPair>& listFragments);
+  void DoFragmentation (Ptr<Packet> packet, const Ipv4Header& ipv4Header, uint32_t outIfaceMtu, std::list<Ipv4PayloadHeaderPair>& listFragments);
 
   /**
    * \brief Process a packet fragment

src/internet/model/ipv4-packet-filter.h

@@ -148,7 +148,19 @@ public:
 
 private:
   virtual int32_t DoClassify (Ptr<QueueDiscItem> item) const;
+
+  /**
+   * \brief Converts a TOS field value into a priority band.
+   * \param tos The tos to convert.
+   * \returns The converted band value.
+   */
   uint32_t TosToBand (uint8_t tos) const;
+
+  /**
+   * \brief Converts a DSCP field value into a priority band.
+   * \param dscpType The DSCP to convert.
+   * \returns The converted band value.
+   */
   uint32_t DscpToBand (Ipv4Header::DscpType dscpType) const;
 
   Ipv4TrafficClassMode m_trafficClassMode; //!< traffic class mode

src/internet/model/ipv4-queue-disc-item.h

@@ -90,8 +90,8 @@ private:
    */
   Ipv4QueueDiscItem &operator = (const Ipv4QueueDiscItem &);
 
-  Ipv4Header m_header;
-  bool m_headerAdded;
+  Ipv4Header m_header;  //!< The IPv4 header.
+  bool m_headerAdded;   //!< True if the header has already been added to the packet.
 };
 
 } // namespace ns3

src/internet/model/ipv6-extension.h

@@ -291,10 +291,12 @@ public:
   typedef std::pair<Ptr<Packet>, Ipv6Header> Ipv6PayloadHeaderPair;
 
   /**
-   * \brief Fragment a packet
-   * \param packet the packet
-   * \param fragmentSize the maximal size of the fragment (unfragmentable part + fragmentation header + fragmentable part)
-   * \param listFragments the list of fragments
+   * \brief Fragment a packet.
+   *
+   * \param packet the packet.
+   * \param ipv6Header the IPv6 header.
+   * \param fragmentSize the maximal size of the fragment (unfragmentable part + fragmentation header + fragmentable part).
+   * \param listFragments the list of fragments.
    */
   void GetFragments (Ptr<Packet> packet, Ipv6Header ipv6Header, uint32_t fragmentSize, std::list<Ipv6PayloadHeaderPair>& listFragments);
 

src/internet/model/ipv6-packet-filter.h

@@ -99,6 +99,12 @@ public:
 
 private:
   virtual int32_t DoClassify (Ptr<QueueDiscItem> item) const;
+
+  /**
+   * \brief Converts a DSCP field value into a priority band.
+   * \param dscpType The DSCP to convert.
+   * \returns The converted band value.
+   */
   uint32_t DscpToBand (Ipv6Header::DscpType dscpType) const;
 };
 

src/internet/model/ipv6-queue-disc-item.h

@@ -90,8 +90,8 @@ private:
    */
   Ipv6QueueDiscItem &operator = (const Ipv6QueueDiscItem &);
 
-  Ipv6Header m_header;
-  bool m_headerAdded;
+  Ipv6Header m_header;  //!< The IPv6 header.
+  bool m_headerAdded;   //!< True if the header has already been added to the packet.
 };
 
 } // namespace ns3

src/internet/model/rip-header.h

@@ -121,14 +121,14 @@ public:
   uint32_t GetRouteMetric (void) const;
 
   /**
-   * \brief Set the route metric.
-   * \param routeMetric The route metric.
+   * \brief Set the next hop.
+   * \param nextHop The next hop.
    */
   void SetNextHop (Ipv4Address nextHop);
 
   /**
-   * \brief Get the route metric.
-   * \returns The route metric.
+   * \brief Get the next hop.
+   * \returns The next hop.
    */
   Ipv4Address GetNextHop (void) const;
 

src/internet/model/tcp-congestion-ops.h

@@ -52,6 +52,11 @@ public:
   static TypeId GetTypeId (void);
 
   TcpCongestionOps ();
+
+  /**
+   * \brief Copy constructor.
+   * \param other object to copy.
+   */
   TcpCongestionOps (const TcpCongestionOps &other);
 
   virtual ~TcpCongestionOps ();
@@ -146,6 +151,11 @@ public:
   static TypeId GetTypeId (void);
 
   TcpNewReno ();
+
+  /**
+   * \brief Copy constructor.
+   * \param sock object to copy.
+   */
   TcpNewReno (const TcpNewReno& sock);
 
   ~TcpNewReno ();

src/internet/model/tcp-l4-protocol.h

@@ -88,15 +88,16 @@ public:
    * of the TCP protocol
    */
   Ptr<Socket> CreateSocket (void);
+
   /**
-   * \brief Create a TCP socket using the specified TypeId
+   * \brief Create a TCP socket using the specified congestion control algorithm TypeId
    *
    * \return A smart Socket pointer to a TcpSocket allocated by this instance
    * of the TCP protocol
    *
-   * \warning using a socketTypeId other than TCP is a bad idea.
+   * \warning using a congestionTypeId other than TCP is a bad idea.
    *
-   * \param socketTypeId the socket TypeId
+   * \param congestionTypeId the congestion control algorithm TypeId
    */
   Ptr<Socket> CreateSocket (TypeId congestionTypeId);
 

src/internet/model/tcp-socket-base.h

@@ -100,6 +100,11 @@ public:
   static TypeId GetTypeId (void);
 
   TcpSocketState ();
+
+  /**
+   * \brief Copy constructor.
+   * \param other object to copy.
+   */
   TcpSocketState (const TcpSocketState &other);
 
   /**

src/internet/model/tcp-socket.h

@@ -181,7 +181,7 @@ private:
 
   /**
    * \brief Set the number of data transmission retries before giving up.
-   * \param count the number of data transmission retries
+   * \param retries the number of data transmission retries
    */
   virtual void SetDataRetries (uint32_t retries) = 0;
 

src/internet/model/tcp-westwood.h

@@ -112,15 +112,15 @@ private:
   /**
    * Update the total number of acknowledged packets during the current RTT
    *
-   * \param acked the number of packets the currently received ACK acknowledges
+   * \param [in] acked the number of packets the currently received ACK acknowledges
    */
   void UpdateAckedSegments (int acked);
 
   /**
    * Estimate the network's bandwidth
    *
-   * \param acked the number of acknowledged packets
-   * \param rtt the RTT estimation
+   * \param [in] rtt the RTT estimation.
+   * \param [in] tcb the socket state.
    */
   void EstimateBW (const Time& rtt, Ptr<TcpSocketState> tcb);