diff --git a/src/internet/helper/ipv4-address-helper.h b/src/internet/helper/ipv4-address-helper.h index 5196df334..ec9ca174b 100644 --- a/src/internet/helper/ipv4-address-helper.h +++ b/src/internet/helper/ipv4-address-helper.h @@ -55,6 +55,9 @@ public: * @brief Construct a helper class to make life easier while doing simple IPv4 * address assignment in scripts. This version sets the base and mask * in the constructor + * @param network the network part + * @param mask the address mask + * @param base the host part to start from */ Ipv4AddressHelper (Ipv4Address network, Ipv4Mask mask, Ipv4Address base = "0.0.0.1"); diff --git a/src/internet/helper/ripng-helper.h b/src/internet/helper/ripng-helper.h index 1075884af..103a7f7e0 100644 --- a/src/internet/helper/ripng-helper.h +++ b/src/internet/helper/ripng-helper.h @@ -135,7 +135,7 @@ private: */ RipNgHelper &operator = (const RipNgHelper &o); - ObjectFactory m_factory; //|< Object Factory + ObjectFactory m_factory; //!< Object Factory std::map< Ptr, std::set > m_interfaceExclusions; //!< Interface Exclusion set std::map< Ptr, std::map > m_interfaceMetrics; //!< Interface Metric set diff --git a/src/internet/model/global-route-manager-impl.h b/src/internet/model/global-route-manager-impl.h index 04443d052..e0f8b430f 100644 --- a/src/internet/model/global-route-manager-impl.h +++ b/src/internet/model/global-route-manager-impl.h @@ -559,12 +559,15 @@ private: /** * @brief The SPFVertex copy construction is disallowed. There's no need for * it and a compiler provided shallow copy would be wrong. + * @param v object to copy from */ SPFVertex (SPFVertex& v); /** * @brief The SPFVertex copy assignment operator is disallowed. There's no * need for it and a compiler provided shallow copy would be wrong. + * @param v object to copy from + * @returns the copied object */ SPFVertex& operator= (SPFVertex& v); @@ -707,12 +710,15 @@ private: /** * @brief GlobalRouteManagerLSDB copy construction is disallowed. There's no * need for it and a compiler provided shallow copy would be wrong. + * @param lsdb object to copy from */ GlobalRouteManagerLSDB (GlobalRouteManagerLSDB& lsdb); /** * @brief The SPFVertex copy assignment operator is disallowed. There's no * need for it and a compiler provided shallow copy would be wrong. + * @param lsdb object to copy from + * @returns the copied object */ GlobalRouteManagerLSDB& operator= (GlobalRouteManagerLSDB& lsdb); }; @@ -776,6 +782,8 @@ private: * @brief GlobalRouteManagerImpl copy construction is disallowed. * There's no need for it and a compiler provided shallow copy would be * wrong. + * + * @param srmi object to copy from */ GlobalRouteManagerImpl (GlobalRouteManagerImpl& srmi); @@ -783,6 +791,9 @@ private: * @brief Global Route Manager Implementation assignment operator is * disallowed. There's no need for it and a compiler provided shallow copy * would be hopelessly wrong. + * + * @param srmi object to copy from + * @returns the copied object */ GlobalRouteManagerImpl& operator= (GlobalRouteManagerImpl& srmi); diff --git a/src/internet/model/global-route-manager.h b/src/internet/model/global-route-manager.h index 0c913cb87..a6538228f 100644 --- a/src/internet/model/global-route-manager.h +++ b/src/internet/model/global-route-manager.h @@ -72,12 +72,16 @@ private: * @brief Global Route Manager copy construction is disallowed. There's no * need for it and a compiler provided shallow copy would be wrong. * + * @param srm object to copy from */ GlobalRouteManager (GlobalRouteManager& srm); /** * @brief Global Router copy assignment operator is disallowed. There's no * need for it and a compiler provided shallow copy would be wrong. + * + * @param srm object to copy from + * @returns the copied object */ GlobalRouteManager& operator= (GlobalRouteManager& srm); }; diff --git a/src/internet/model/global-router-interface.h b/src/internet/model/global-router-interface.h index b569c1700..c8b6acb9c 100644 --- a/src/internet/model/global-router-interface.h +++ b/src/internet/model/global-router-interface.h @@ -376,6 +376,7 @@ public: /** * @brief Print the contents of the Global Routing Link State Advertisement and * any Global Routing Link Records present in the list. Quite verbose. + * @param os the output stream */ void Print (std::ostream &os) const; diff --git a/src/internet/model/ipv6-l3-protocol.h b/src/internet/model/ipv6-l3-protocol.h index 36907750a..3bb1b704a 100644 --- a/src/internet/model/ipv6-l3-protocol.h +++ b/src/internet/model/ipv6-l3-protocol.h @@ -379,7 +379,7 @@ public: * * This function is used by Fragment Timeout handling to signal a fragment drop. * - * \param ipv6Header the IPv6 header of dropped packet + * \param ipHeader the IPv6 header of dropped packet * \param p the packet (if available) * \param dropReason the drop reason * diff --git a/src/internet/model/ripng-header.h b/src/internet/model/ripng-header.h index 9aa237635..0ff487f55 100644 --- a/src/internet/model/ripng-header.h +++ b/src/internet/model/ripng-header.h @@ -128,6 +128,14 @@ private: uint8_t m_metric; //!< route metric }; +/** + * \brief Stream insertion operator. + * + * \param os the reference to the output stream + * \param h the Routing Table Entry + * \returns the reference to the output stream + */ +std::ostream & operator << (std::ostream & os, const RipNgRte & h); /** * \ingroup ripng @@ -220,6 +228,15 @@ private: std::list m_rteList; //!< list of the RTEs in the message }; +/** + * \brief Stream insertion operator. + * + * \param os the reference to the output stream + * \param h the RIPng header + * \returns the reference to the output stream + */ +std::ostream & operator << (std::ostream & os, const RipNgHeader & h); + } #endif /* RIPNG_HEADER_H */ diff --git a/src/internet/model/ripng.h b/src/internet/model/ripng.h index 5f581791c..eff8d9279 100644 --- a/src/internet/model/ripng.h +++ b/src/internet/model/ripng.h @@ -136,7 +136,7 @@ public: * After a Triggered Update, all the changed flags are cleared * from the routing table. * - * \param true if route is changed + * \param changed true if route is changed */ void SetRouteChanged (bool changed); @@ -177,6 +177,10 @@ public: RipNg (); virtual ~RipNg (); + /** + * \brief Get the type ID + * \return type ID + */ static TypeId GetTypeId (void); // \name From Ipv6RoutingProtocol @@ -198,10 +202,13 @@ public: virtual void PrintRoutingTable (Ptr stream) const; // \} + /** + * Split Horizon strategy type. See \RFC{2080}. + */ enum SplitHorizonType_e { - NO_SPLIT_HORIZON, - SPLIT_HORIZON, - POISON_REVERSE, + NO_SPLIT_HORIZON,//!< No Split Horizon + SPLIT_HORIZON, //!< Split Horizon + POISON_REVERSE, //!< Poison Reverse Split Horizon }; /** @@ -323,11 +330,10 @@ private: /** * \brief Add route to network. * \param network network address - * \param networkPrefix network prefix* + * \param networkPrefix network prefix * \param nextHop next hop address to route the packet. * \param interface interface index * \param prefixToUse prefix that should be used for source address for this destination - * \param metric metric of route in case of multiple routes to same destination */ void AddNetworkRouteTo (Ipv6Address network, Ipv6Prefix networkPrefix, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse); @@ -336,7 +342,6 @@ private: * \param network network address * \param networkPrefix network prefix * \param interface interface index - * \param metric metric of route in case of multiple routes to same destination */ void AddNetworkRouteTo (Ipv6Address network, Ipv6Prefix networkPrefix, uint32_t interface); @@ -391,19 +396,19 @@ private: typedef std::map, uint32_t>::const_iterator SocketListCI; SocketList m_sendSocketList; //!< list of sockets for sending (socket, interface index) - Ptr m_recvSocket; + Ptr m_recvSocket; //!< receive socket EventId m_nextUnsolicitedUpdate; //!< Next Unsolicited Update event EventId m_nextTriggeredUpdate; //!< Next Triggered Update event Ptr m_rng; //!< Rng stream. - std::set m_interfaceExclusions; // Set of excluded interfaces - std::map m_interfaceMetrics; // Map of interface metrics + std::set m_interfaceExclusions; //!< Set of excluded interfaces + std::map m_interfaceMetrics; //!< Map of interface metrics - SplitHorizonType_e m_splitHorizonStrategy; // Split Horizon strategy + SplitHorizonType_e m_splitHorizonStrategy; //!< Split Horizon strategy - bool m_initialized; // flag to allow socket's late-creation. + bool m_initialized; //!< flag to allow socket's late-creation. }; } // namespace ns3