tweak doxygen
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Fri, 03 Jul 2009 09:08:01 +0200
changeset 4648 e72d6bc8b814
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
--- a/src/helper/ipv4-list-routing-helper.h	Thu Jul 02 22:10:38 2009 -0700
+++ b/src/helper/ipv4-list-routing-helper.h	Fri Jul 03 09:08:01 2009 +0200
@@ -28,6 +28,9 @@
 
 /**
  * \brief Helper class that adds ns3::Ipv4ListRouting objects
+ *
+ * This class is expected to be used in conjunction with 
+ * ns3::InternetStackHelper::SetRoutingHelper
  */
 class Ipv4ListRoutingHelper : public Ipv4RoutingHelper
 {
--- a/src/helper/ipv4-routing-helper.h	Thu Jul 02 22:10:38 2009 -0700
+++ b/src/helper/ipv4-routing-helper.h	Fri Jul 03 09:08:01 2009 +0200
@@ -33,7 +33,7 @@
  * For each new routing protocol created as a subclass of 
  * ns3::Ipv4RoutingProtocol, you need to create a subclass of 
  * ns3::Ipv4RoutingHelper which can be used by 
- * ns3::InternetStackHelper::SetRoutingProtocol and 
+ * ns3::InternetStackHelper::SetRoutingHelper and 
  * ns3::InternetStackHelper::Install.
  */
 class Ipv4RoutingHelper
--- a/src/helper/ipv4-static-routing-helper.h	Thu Jul 02 22:10:38 2009 -0700
+++ b/src/helper/ipv4-static-routing-helper.h	Fri Jul 03 09:08:01 2009 +0200
@@ -33,6 +33,9 @@
 
 /**
  * \brief Helper class that adds ns3::Ipv4StaticRouting objects
+ *
+ * This class is expected to be used in conjunction with 
+ * ns3::InternetStackHelper::SetRoutingHelper
  */
 class Ipv4StaticRoutingHelper : public Ipv4RoutingHelper
 {
--- a/src/helper/nqos-wifi-mac-helper.h	Thu Jul 02 22:10:38 2009 -0700
+++ b/src/helper/nqos-wifi-mac-helper.h	Fri Jul 03 09:08:01 2009 +0200
@@ -24,6 +24,10 @@
 
 namespace ns3 {
 
+/**
+ * \brief create non-qos MAC layers for a ns3::WifiNetDevice. 
+ * This class can create MACs of type ns3::NqapWifiMac, ns3::NqstaWifiMac, and, ns3::AdhocWifiMac
+ */
 class NqosWifiMacHelper : public WifiMacHelper
 {
 public:
--- a/src/helper/olsr-helper.h	Thu Jul 02 22:10:38 2009 -0700
+++ b/src/helper/olsr-helper.h	Fri Jul 03 09:08:01 2009 +0200
@@ -29,6 +29,9 @@
 
 /**
  * \brief Helper class that adds OLSR routing to nodes.
+ *
+ * This class is expected to be used in conjunction with 
+ * ns3::InternetStackHelper::SetRoutingHelper
  */
 class OlsrHelper : public Ipv4RoutingHelper
 {
--- a/src/helper/qos-wifi-mac-helper.h	Thu Jul 02 22:10:38 2009 -0700
+++ b/src/helper/qos-wifi-mac-helper.h	Fri Jul 03 09:08:01 2009 +0200
@@ -27,6 +27,10 @@
 
 namespace ns3 {
 
+/**
+ * \brief create qos MAC layers for a ns3::WifiNetDevice. 
+ * This class can create MACs of type ns3::QapWifiMac, ns3::QstaWifiMac, and, ns3::QadhocWifiMac
+ */
 class QosWifiMacHelper : public WifiMacHelper
 {
 public: