improve doxygen
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon, 14 Apr 2008 16:18:30 -0700
changeset 2962 39f72ca0ba8e
parent 2961 2bcb3435483b
child 2963 40a70a2e1b70
improve doxygen
src/applications/udp-echo/udp-echo-client.h
src/applications/udp-echo/udp-echo-server.h
src/contrib/config-store.h
src/devices/wifi/amrr-wifi-manager.h
src/devices/wifi/onoe-wifi-manager.h
--- a/src/applications/udp-echo/udp-echo-client.h	Mon Apr 14 16:06:44 2008 -0700
+++ b/src/applications/udp-echo/udp-echo-client.h	Mon Apr 14 16:18:30 2008 -0700
@@ -29,6 +29,11 @@
 class Socket;
 class Packet;
 
+/**
+ * \brief A Udp Echo client
+ *
+ * Every packet sent should be returned by the server and received here.
+ */
 class UdpEchoClient : public Application 
 {
 public:
--- a/src/applications/udp-echo/udp-echo-server.h	Mon Apr 14 16:06:44 2008 -0700
+++ b/src/applications/udp-echo/udp-echo-server.h	Mon Apr 14 16:18:30 2008 -0700
@@ -29,6 +29,11 @@
 class Socket;
 class Packet;
 
+/**
+ * \brief A Udp Echo server
+ *
+ * Every packet received is sent back.
+ */
 class UdpEchoServer : public Application 
 {
 public:
--- a/src/contrib/config-store.h	Mon Apr 14 16:06:44 2008 -0700
+++ b/src/contrib/config-store.h	Mon Apr 14 16:18:30 2008 -0700
@@ -7,6 +7,10 @@
 
 namespace ns3 {
 
+/**
+ * \brief Store and load simulation attribute configuration
+ *
+ */
 class ConfigStore : public ObjectBase
 {
 public:
@@ -15,6 +19,11 @@
 
   ConfigStore ();
 
+  /**
+   * Depending on which attribute was set:
+   *  - Store simulation configuration in file and exit
+   *  - Load simulation configuration from file and proceed.
+   */
   void Configure (void);
 
 private:
--- a/src/devices/wifi/amrr-wifi-manager.h	Mon Apr 14 16:06:44 2008 -0700
+++ b/src/devices/wifi/amrr-wifi-manager.h	Mon Apr 14 16:18:30 2008 -0700
@@ -25,6 +25,14 @@
 
 namespace ns3 {
 
+/**
+ * \brief AMRR Rate control algorithm
+ *
+ * This class implements the AMRR rate control algorithm which
+ * was initially described in <i>IEEE 802.11 Rate Adaptation:
+ * A Practical Approach</i>, by M. Lacage, M.H. Manshaei, and 
+ * T. Turletti.
+ */
 class AmrrWifiManager : public WifiRemoteStationManager
 {
 public:
--- a/src/devices/wifi/onoe-wifi-manager.h	Mon Apr 14 16:06:44 2008 -0700
+++ b/src/devices/wifi/onoe-wifi-manager.h	Mon Apr 14 16:18:30 2008 -0700
@@ -25,6 +25,15 @@
 
 namespace ns3 {
 
+/**
+ * \brief an implementation of rate control algorithm developed 
+ *        by Atsushi Onoe
+ *
+ * This algorithm is well known because it has been used as the default
+ * rate control algorithm for the madwifi driver. I am not aware of
+ * any publication or reference about this algorithm beyond the madwifi
+ * source code.
+ */
 class OnoeWifiManager : public WifiRemoteStationManager
 {
 public:
@@ -41,15 +50,6 @@
   uint32_t m_raiseThreshold;
 };
 
-/**
- * \brief an implementation of rate control algorithm developed 
- *        by Atsushi Onoe
- *
- * This algorithm is well known because it has been used as the default
- * rate control algorithm for the madwifi driver. I am not aware of
- * any publication or reference about this algorithm beyond the madwifi
- * source code.
- */
 class OnoeWifiRemoteStation : public WifiRemoteStation
 {
 public: