tweak doxygen
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Fri, 03 Jul 2009 09:08:01 +0200
changeset 4648e72d6bc8b814
parent 4647 b69bef7e00ed
child 4649 189238bfdc7f
tweak doxygen
src/helper/ipv4-list-routing-helper.h
src/helper/ipv4-routing-helper.h
src/helper/ipv4-static-routing-helper.h
src/helper/nqos-wifi-mac-helper.h
src/helper/olsr-helper.h
src/helper/qos-wifi-mac-helper.h
     1.1 --- a/src/helper/ipv4-list-routing-helper.h	Thu Jul 02 22:10:38 2009 -0700
     1.2 +++ b/src/helper/ipv4-list-routing-helper.h	Fri Jul 03 09:08:01 2009 +0200
     1.3 @@ -28,6 +28,9 @@
     1.4  
     1.5  /**
     1.6   * \brief Helper class that adds ns3::Ipv4ListRouting objects
     1.7 + *
     1.8 + * This class is expected to be used in conjunction with 
     1.9 + * ns3::InternetStackHelper::SetRoutingHelper
    1.10   */
    1.11  class Ipv4ListRoutingHelper : public Ipv4RoutingHelper
    1.12  {
     2.1 --- a/src/helper/ipv4-routing-helper.h	Thu Jul 02 22:10:38 2009 -0700
     2.2 +++ b/src/helper/ipv4-routing-helper.h	Fri Jul 03 09:08:01 2009 +0200
     2.3 @@ -33,7 +33,7 @@
     2.4   * For each new routing protocol created as a subclass of 
     2.5   * ns3::Ipv4RoutingProtocol, you need to create a subclass of 
     2.6   * ns3::Ipv4RoutingHelper which can be used by 
     2.7 - * ns3::InternetStackHelper::SetRoutingProtocol and 
     2.8 + * ns3::InternetStackHelper::SetRoutingHelper and 
     2.9   * ns3::InternetStackHelper::Install.
    2.10   */
    2.11  class Ipv4RoutingHelper
     3.1 --- a/src/helper/ipv4-static-routing-helper.h	Thu Jul 02 22:10:38 2009 -0700
     3.2 +++ b/src/helper/ipv4-static-routing-helper.h	Fri Jul 03 09:08:01 2009 +0200
     3.3 @@ -33,6 +33,9 @@
     3.4  
     3.5  /**
     3.6   * \brief Helper class that adds ns3::Ipv4StaticRouting objects
     3.7 + *
     3.8 + * This class is expected to be used in conjunction with 
     3.9 + * ns3::InternetStackHelper::SetRoutingHelper
    3.10   */
    3.11  class Ipv4StaticRoutingHelper : public Ipv4RoutingHelper
    3.12  {
     4.1 --- a/src/helper/nqos-wifi-mac-helper.h	Thu Jul 02 22:10:38 2009 -0700
     4.2 +++ b/src/helper/nqos-wifi-mac-helper.h	Fri Jul 03 09:08:01 2009 +0200
     4.3 @@ -24,6 +24,10 @@
     4.4  
     4.5  namespace ns3 {
     4.6  
     4.7 +/**
     4.8 + * \brief create non-qos MAC layers for a ns3::WifiNetDevice. 
     4.9 + * This class can create MACs of type ns3::NqapWifiMac, ns3::NqstaWifiMac, and, ns3::AdhocWifiMac
    4.10 + */
    4.11  class NqosWifiMacHelper : public WifiMacHelper
    4.12  {
    4.13  public:
     5.1 --- a/src/helper/olsr-helper.h	Thu Jul 02 22:10:38 2009 -0700
     5.2 +++ b/src/helper/olsr-helper.h	Fri Jul 03 09:08:01 2009 +0200
     5.3 @@ -29,6 +29,9 @@
     5.4  
     5.5  /**
     5.6   * \brief Helper class that adds OLSR routing to nodes.
     5.7 + *
     5.8 + * This class is expected to be used in conjunction with 
     5.9 + * ns3::InternetStackHelper::SetRoutingHelper
    5.10   */
    5.11  class OlsrHelper : public Ipv4RoutingHelper
    5.12  {
     6.1 --- a/src/helper/qos-wifi-mac-helper.h	Thu Jul 02 22:10:38 2009 -0700
     6.2 +++ b/src/helper/qos-wifi-mac-helper.h	Fri Jul 03 09:08:01 2009 +0200
     6.3 @@ -27,6 +27,10 @@
     6.4  
     6.5  namespace ns3 {
     6.6  
     6.7 +/**
     6.8 + * \brief create qos MAC layers for a ns3::WifiNetDevice. 
     6.9 + * This class can create MACs of type ns3::QapWifiMac, ns3::QstaWifiMac, and, ns3::QadhocWifiMac
    6.10 + */
    6.11  class QosWifiMacHelper : public WifiMacHelper
    6.12  {
    6.13  public: