From e56c013bb11a9d37f77d682966b67f40247b3bd0 Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Wed, 8 Jul 2009 10:05:39 -0700 Subject: [PATCH] fix doxygen errors --- doc/modules | 4 ++-- src/helper/nqos-wifi-mac-helper.h | 2 +- src/helper/qos-wifi-mac-helper.h | 2 +- src/node/ipv4-routing-protocol.h | 11 +++++++---- src/routing/list-routing/ipv4-list-routing.h | 2 +- src/routing/static-routing/ipv4-routing-table-entry.h | 4 ++-- src/routing/static-routing/ipv4-static-routing.h | 2 +- 7 files changed, 15 insertions(+), 12 deletions(-) diff --git a/doc/modules b/doc/modules index 7c6a7b347..36b640ee5 100644 --- a/doc/modules +++ b/doc/modules @@ -49,14 +49,14 @@ * - an ARP module * - a UDP and a TCP implementation * + * @defgroup routing Routing + * * @defgroup helper Helpers * * @defgroup applications Applications * * @defgroup mobility Mobility * - * @defgroup routing Routing - * * @defgroup constants Constants * @brief Constants you can change * diff --git a/src/helper/nqos-wifi-mac-helper.h b/src/helper/nqos-wifi-mac-helper.h index ae67b1922..032d783ba 100644 --- a/src/helper/nqos-wifi-mac-helper.h +++ b/src/helper/nqos-wifi-mac-helper.h @@ -70,7 +70,6 @@ public: std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (), std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ()); /** - * \param type the type of ns3::WifiMac to create. * \param n0 the name of the attribute to set * \param v0 the value of the attribute to set * \param n1 the name of the attribute to set @@ -78,6 +77,7 @@ public: * \param n2 the name of the attribute to set * \param v2 the value of the attribute to set * \param n3 the name of the attribute to set + * \param v3 the value of the attribute to set */ void SetDcaParameters (std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (), std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (), diff --git a/src/helper/qos-wifi-mac-helper.h b/src/helper/qos-wifi-mac-helper.h index 32537283a..cfe1cb84f 100644 --- a/src/helper/qos-wifi-mac-helper.h +++ b/src/helper/qos-wifi-mac-helper.h @@ -74,7 +74,7 @@ public: /** * \param accessClass access class for which we are setting aggregator. Possibilities * are: AC_BK, AC_BE, AC_VI, AC_VO. - * \param aggregatorType type of aggregator. + * \param type the type of ns3::WifiMac to create. * \param n0 the name of the attribute to set * \param v0 the value of the attribute to set * \param n1 the name of the attribute to set diff --git a/src/node/ipv4-routing-protocol.h b/src/node/ipv4-routing-protocol.h index aa5d2eb4f..23ec9ca30 100644 --- a/src/node/ipv4-routing-protocol.h +++ b/src/node/ipv4-routing-protocol.h @@ -34,10 +34,13 @@ class NetDevice; /** * \ingroup node - * \defgroup ipv4Routing Ipv4 Routing - * - * Abstract base class for Ipv4 routing protocols. Defines two - * virtual functions for packet routing and forwarding. The first, + * \defgroup ipv4Routing Ipv4RoutingProtocol + */ +/* + * \ingroup ipv4Routing + * \brief Abstract base class for IPv4 routing protocols. + * + * Defines two virtual functions for packet routing and forwarding. The first, * RouteOutput(), is used for locally originated packets, and the second, * RouteInput(), is used for forwarding and/or delivering received packets. * Also defines the signatures of four callbacks used in RouteInput(). diff --git a/src/routing/list-routing/ipv4-list-routing.h b/src/routing/list-routing/ipv4-list-routing.h index 1ae86aaae..541411a1e 100644 --- a/src/routing/list-routing/ipv4-list-routing.h +++ b/src/routing/list-routing/ipv4-list-routing.h @@ -25,7 +25,7 @@ namespace ns3 { /** - * \ingroup ipv4Routing + * \ingroup routing * * This class is a specialization of Ipv4RoutingProtocol that allows * other instances of Ipv4RoutingProtocol to be inserted in a diff --git a/src/routing/static-routing/ipv4-routing-table-entry.h b/src/routing/static-routing/ipv4-routing-table-entry.h index b4597afde..f5f8cde89 100644 --- a/src/routing/static-routing/ipv4-routing-table-entry.h +++ b/src/routing/static-routing/ipv4-routing-table-entry.h @@ -29,7 +29,7 @@ namespace ns3 { /** - * \ingroup ipv4Routing + * \ingroup routing * * A record of an IPv4 routing table entry for Ipv4GlobalRouting and * Ipv4StaticRouting. This is not a reference counted object. @@ -155,7 +155,7 @@ private: std::ostream& operator<< (std::ostream& os, Ipv4RoutingTableEntry const& route); /** - * \ingroup ipv4Routing + * \ingroup routing * * \brief A record of an IPv4 multicast route for Ipv4GlobalRouting and Ipv4StaticRouting */ diff --git a/src/routing/static-routing/ipv4-static-routing.h b/src/routing/static-routing/ipv4-static-routing.h index 9f7ed0b85..3564602aa 100644 --- a/src/routing/static-routing/ipv4-static-routing.h +++ b/src/routing/static-routing/ipv4-static-routing.h @@ -43,7 +43,7 @@ class Ipv4MulticastRoutingTableEntry; class Node; /** - * \ingroup ipv4Routing + * \ingroup routing * * \brief Static routing protocol for IP version 4 stacks. *