From 23d3d0c46df09a4bb8a33526a2792a320636478c Mon Sep 17 00:00:00 2001 From: Tommaso Pecorella Date: Thu, 7 Apr 2016 00:24:47 +0200 Subject: [PATCH] internet: doxygen fixes --- src/internet/model/global-router-interface.h | 3 +++ src/internet/model/ipv4-global-routing.h | 6 ++++++ src/internet/model/ipv4-l3-protocol.h | 4 ++-- src/internet/model/ipv4-packet-filter.h | 12 ++++++++++++ src/internet/model/ipv4-queue-disc-item.h | 4 ++-- src/internet/model/ipv6-extension.h | 10 ++++++---- src/internet/model/ipv6-packet-filter.h | 6 ++++++ src/internet/model/ipv6-queue-disc-item.h | 4 ++-- src/internet/model/rip-header.h | 8 ++++---- src/internet/model/tcp-congestion-ops.h | 10 ++++++++++ src/internet/model/tcp-l4-protocol.h | 7 ++++--- src/internet/model/tcp-socket-base.h | 5 +++++ src/internet/model/tcp-socket.h | 2 +- src/internet/model/tcp-westwood.h | 6 +++--- 14 files changed, 66 insertions(+), 21 deletions(-) diff --git a/src/internet/model/global-router-interface.h b/src/internet/model/global-router-interface.h index ef86bc354..8def09949 100644 --- a/src/internet/model/global-router-interface.h +++ b/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 > m_bridgesVisited; /** * Clear the list of bridges visited on the link diff --git a/src/internet/model/ipv4-global-routing.h b/src/internet/model/ipv4-global-routing.h index b699d0941..151fcec97 100644 --- a/src/internet/model/ipv4-global-routing.h +++ b/src/internet/model/ipv4-global-routing.h @@ -258,6 +258,12 @@ private: /// iterator of container of Ipv4RoutingTableEntry (routes to external AS) typedef std::list::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 LookupGlobal (Ipv4Address dest, Ptr oif = 0); HostRoutes m_hostRoutes; //!< Routes to hosts diff --git a/src/internet/model/ipv4-l3-protocol.h b/src/internet/model/ipv4-l3-protocol.h index 2381aa2e3..ef6bbebaa 100644 --- a/src/internet/model/ipv4-l3-protocol.h +++ b/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, const Ipv4Header & ipv4Header, uint32_t outIfaceMtu, std::list& listFragments); + void DoFragmentation (Ptr packet, const Ipv4Header& ipv4Header, uint32_t outIfaceMtu, std::list& listFragments); /** * \brief Process a packet fragment diff --git a/src/internet/model/ipv4-packet-filter.h b/src/internet/model/ipv4-packet-filter.h index 849ab490f..76139cce5 100644 --- a/src/internet/model/ipv4-packet-filter.h +++ b/src/internet/model/ipv4-packet-filter.h @@ -148,7 +148,19 @@ public: private: virtual int32_t DoClassify (Ptr 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 diff --git a/src/internet/model/ipv4-queue-disc-item.h b/src/internet/model/ipv4-queue-disc-item.h index 87878778f..ba2511e55 100644 --- a/src/internet/model/ipv4-queue-disc-item.h +++ b/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 diff --git a/src/internet/model/ipv6-extension.h b/src/internet/model/ipv6-extension.h index 3831e101b..688eb8cd5 100644 --- a/src/internet/model/ipv6-extension.h +++ b/src/internet/model/ipv6-extension.h @@ -291,10 +291,12 @@ public: typedef std::pair, 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, Ipv6Header ipv6Header, uint32_t fragmentSize, std::list& listFragments); diff --git a/src/internet/model/ipv6-packet-filter.h b/src/internet/model/ipv6-packet-filter.h index c8f0f61ef..28bf14454 100644 --- a/src/internet/model/ipv6-packet-filter.h +++ b/src/internet/model/ipv6-packet-filter.h @@ -99,6 +99,12 @@ public: private: virtual int32_t DoClassify (Ptr 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; }; diff --git a/src/internet/model/ipv6-queue-disc-item.h b/src/internet/model/ipv6-queue-disc-item.h index ef3e949a7..889aa4679 100644 --- a/src/internet/model/ipv6-queue-disc-item.h +++ b/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 diff --git a/src/internet/model/rip-header.h b/src/internet/model/rip-header.h index 547bfbc7d..5028d3e79 100644 --- a/src/internet/model/rip-header.h +++ b/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; diff --git a/src/internet/model/tcp-congestion-ops.h b/src/internet/model/tcp-congestion-ops.h index 3b46e50e1..aa92a44a5 100644 --- a/src/internet/model/tcp-congestion-ops.h +++ b/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 (); diff --git a/src/internet/model/tcp-l4-protocol.h b/src/internet/model/tcp-l4-protocol.h index cf40cca4e..adeb83967 100644 --- a/src/internet/model/tcp-l4-protocol.h +++ b/src/internet/model/tcp-l4-protocol.h @@ -88,15 +88,16 @@ public: * of the TCP protocol */ Ptr 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 CreateSocket (TypeId congestionTypeId); diff --git a/src/internet/model/tcp-socket-base.h b/src/internet/model/tcp-socket-base.h index 1b90afbe0..03e9c917a 100644 --- a/src/internet/model/tcp-socket-base.h +++ b/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); /** diff --git a/src/internet/model/tcp-socket.h b/src/internet/model/tcp-socket.h index e59664a10..cef344dee 100644 --- a/src/internet/model/tcp-socket.h +++ b/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; diff --git a/src/internet/model/tcp-westwood.h b/src/internet/model/tcp-westwood.h index 39df7e9ab..be8c2fdd2 100644 --- a/src/internet/model/tcp-westwood.h +++ b/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 tcb);