fix doxygen errors
authorTom Henderson <tomh@tomh.org>
Wed Jul 08 10:05:39 2009 -0700 (7 months ago)
changeset 469336b78cddce4d
parent 4692 fdf71375766a
child 4694 6dc56539a891
fix doxygen errors
doc/modules
src/helper/nqos-wifi-mac-helper.h
src/helper/qos-wifi-mac-helper.h
src/node/ipv4-routing-protocol.h
src/routing/list-routing/ipv4-list-routing.h
src/routing/static-routing/ipv4-routing-table-entry.h
src/routing/static-routing/ipv4-static-routing.h
     1.1 --- a/doc/modules	Wed Jul 08 11:14:16 2009 +0100
     1.2 +++ b/doc/modules	Wed Jul 08 10:05:39 2009 -0700
     1.3 @@ -49,14 +49,14 @@
     1.4   *    - an ARP module
     1.5   *    - a UDP and a TCP implementation
     1.6   *    
     1.7 + * @defgroup routing Routing
     1.8 + *
     1.9   * @defgroup helper Helpers
    1.10   * 
    1.11   * @defgroup applications Applications
    1.12   *
    1.13   * @defgroup mobility Mobility
    1.14   *
    1.15 - * @defgroup routing Routing
    1.16 - *
    1.17   * @defgroup constants Constants
    1.18   * @brief Constants you can change
    1.19   *
     2.1 --- a/src/helper/nqos-wifi-mac-helper.h	Wed Jul 08 11:14:16 2009 +0100
     2.2 +++ b/src/helper/nqos-wifi-mac-helper.h	Wed Jul 08 10:05:39 2009 -0700
     2.3 @@ -70,7 +70,6 @@
     2.4                  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
     2.5                  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
     2.6    /**
     2.7 -   * \param type the type of ns3::WifiMac to create.
     2.8     * \param n0 the name of the attribute to set
     2.9     * \param v0 the value of the attribute to set
    2.10     * \param n1 the name of the attribute to set
    2.11 @@ -78,6 +77,7 @@
    2.12     * \param n2 the name of the attribute to set
    2.13     * \param v2 the value of the attribute to set
    2.14     * \param n3 the name of the attribute to set
    2.15 +   * \param v3 the value of the attribute to set
    2.16     */
    2.17    void SetDcaParameters (std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
    2.18                           std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
     3.1 --- a/src/helper/qos-wifi-mac-helper.h	Wed Jul 08 11:14:16 2009 +0100
     3.2 +++ b/src/helper/qos-wifi-mac-helper.h	Wed Jul 08 10:05:39 2009 -0700
     3.3 @@ -74,7 +74,7 @@
     3.4    /**
     3.5     * \param accessClass access class for which we are setting aggregator. Possibilities
     3.6     *  are: AC_BK, AC_BE, AC_VI, AC_VO.
     3.7 -   * \param aggregatorType type of aggregator.
     3.8 +   * \param type the type of ns3::WifiMac to create.
     3.9     * \param n0 the name of the attribute to set
    3.10     * \param v0 the value of the attribute to set
    3.11     * \param n1 the name of the attribute to set
     4.1 --- a/src/node/ipv4-routing-protocol.h	Wed Jul 08 11:14:16 2009 +0100
     4.2 +++ b/src/node/ipv4-routing-protocol.h	Wed Jul 08 10:05:39 2009 -0700
     4.3 @@ -34,10 +34,13 @@
     4.4  
     4.5  /**
     4.6   * \ingroup node 
     4.7 - * \defgroup ipv4Routing Ipv4 Routing
     4.8 - *
     4.9 - * Abstract base class for Ipv4 routing protocols.  Defines two
    4.10 - * virtual functions for packet routing and forwarding.  The first, 
    4.11 + * \defgroup ipv4Routing Ipv4RoutingProtocol 
    4.12 + */
    4.13 +/*
    4.14 + * \ingroup ipv4Routing
    4.15 + * \brief Abstract base class for IPv4 routing protocols. 
    4.16 + * 
    4.17 + * Defines two virtual functions for packet routing and forwarding.  The first, 
    4.18   * RouteOutput(), is used for locally originated packets, and the second,
    4.19   * RouteInput(), is used for forwarding and/or delivering received packets. 
    4.20   * Also defines the signatures of four callbacks used in RouteInput().
     5.1 --- a/src/routing/list-routing/ipv4-list-routing.h	Wed Jul 08 11:14:16 2009 +0100
     5.2 +++ b/src/routing/list-routing/ipv4-list-routing.h	Wed Jul 08 10:05:39 2009 -0700
     5.3 @@ -25,7 +25,7 @@
     5.4  namespace ns3 {
     5.5  
     5.6  /**
     5.7 - * \ingroup ipv4Routing 
     5.8 + * \ingroup routing 
     5.9   *
    5.10   * This class is a specialization of Ipv4RoutingProtocol that allows 
    5.11   * other instances of Ipv4RoutingProtocol to be inserted in a 
     6.1 --- a/src/routing/static-routing/ipv4-routing-table-entry.h	Wed Jul 08 11:14:16 2009 +0100
     6.2 +++ b/src/routing/static-routing/ipv4-routing-table-entry.h	Wed Jul 08 10:05:39 2009 -0700
     6.3 @@ -29,7 +29,7 @@
     6.4  namespace ns3 {
     6.5  
     6.6  /**
     6.7 - * \ingroup ipv4Routing
     6.8 + * \ingroup routing
     6.9   *
    6.10   * A record of an IPv4 routing table entry for Ipv4GlobalRouting and 
    6.11   * Ipv4StaticRouting.  This is not a reference counted object.
    6.12 @@ -155,7 +155,7 @@
    6.13  std::ostream& operator<< (std::ostream& os, Ipv4RoutingTableEntry const& route);
    6.14  
    6.15  /**
    6.16 - * \ingroup ipv4Routing
    6.17 + * \ingroup routing
    6.18   *
    6.19   * \brief A record of an IPv4 multicast route for Ipv4GlobalRouting and Ipv4StaticRouting
    6.20   */
     7.1 --- a/src/routing/static-routing/ipv4-static-routing.h	Wed Jul 08 11:14:16 2009 +0100
     7.2 +++ b/src/routing/static-routing/ipv4-static-routing.h	Wed Jul 08 10:05:39 2009 -0700
     7.3 @@ -43,7 +43,7 @@
     7.4  class Node;
     7.5  
     7.6  /**
     7.7 - * \ingroup ipv4Routing
     7.8 + * \ingroup routing
     7.9   * 
    7.10   * \brief Static routing protocol for IP version 4 stacks.
    7.11   *