Doxygen cleanup
authorPavel Boyko <boyko@iitp.ru>
Mon, 13 Apr 2009 09:33:58 +0400
changeset 4960 75e769c55b77
parent 4959 8ded7cc99f71
child 4961 62ff08884f5e
Doxygen cleanup
src/devices/mesh/dot11s/dot11s-mac-header.h
src/devices/mesh/dot11s/dot11s.h
src/devices/mesh/mesh.h
--- a/src/devices/mesh/dot11s/dot11s-mac-header.h	Mon Apr 13 09:12:18 2009 +0400
+++ b/src/devices/mesh/dot11s/dot11s-mac-header.h	Mon Apr 13 09:33:58 2009 +0400
@@ -29,8 +29,10 @@
 namespace dot11s {
 /**
  * \ingroup dot11s
+ * 
+ * \brief See IEEE 802.11s draft 3.0 section 7.1.3.5b
  */
-class Dot11sMacHeader : public Header //7.1.3.5b
+class Dot11sMacHeader : public Header
 {
 public:
   Dot11sMacHeader ();
@@ -68,18 +70,22 @@
   friend bool operator== (const Dot11sMacHeader & a, const Dot11sMacHeader & b);
 };
 bool operator== (const Dot11sMacHeader & a, const Dot11sMacHeader & b);
+
 /**
- * \ingroup mesh
+ * \ingroup dot11s
+ * 
+ * \brief See IEEE 802.11s draft 3.0 section 7.2.3.14
+ * 
+ * Multichop action frame consists of Mesh header, Action, and
+ * the last information. Mesh header is present within all data
+ * frames and multihop action frames, so Mesh header is a
+ * separate structure. Each MultihopAction frames (frames like
+ * PREQ, PREP and other) start form Category field and Action
+ * value field, so the Multihop Action Frame should containt
+ * three fields: Category, Action Value.
  */
-class WifiMeshMultihopActionHeader : public Header //7.2.3.14
+class WifiMeshMultihopActionHeader : public Header 
 {
-  //Multichop action frame consists of Mesh header, Action, and
-  //the last information. Mesh header is present within all data
-  //frames and multihop action frames, so Mesh header is a
-  //separate structure. Each MultihopAction frames (frames like
-  //PREQ, PREP and other) start form Category field and Action
-  //value field, so the Multihop Action Frame should containt
-  //three fields: Category, Action Value;
 public:
   WifiMeshMultihopActionHeader ();
   ~WifiMeshMultihopActionHeader ();
--- a/src/devices/mesh/dot11s/dot11s.h	Mon Apr 13 09:12:18 2009 +0400
+++ b/src/devices/mesh/dot11s/dot11s.h	Mon Apr 13 09:33:58 2009 +0400
@@ -25,5 +25,10 @@
  * 
  * \brief IEEE 802.11s (mesh) draft standard implementation
  * 
- * TODO: add documentation on 802.11s implementation here
+ * Current model conforms IEEE 802.11s D3.0 draft version and includes
+ * Peer Management Protocol and HWMP (routing) Protocol implementations.
+ * 
+ * The multi-interface (aka multi radio) mesh points are supported as an 
+ * extensions of ieee draft version 3.0. Note that corresponding helper
+ * creates single interface station by default.  
  */
\ No newline at end of file
--- a/src/devices/mesh/mesh.h	Mon Apr 13 09:12:18 2009 +0400
+++ b/src/devices/mesh/mesh.h	Mon Apr 13 09:33:58 2009 +0400
@@ -24,7 +24,7 @@
  * \ingroup devices
  * \defgroup mesh Mesh
  *
- * \brief Level 2 mobile ad hoc wireless networking
+ * \brief Layer 2 mobile ad hoc wireless (aka mesh) networking
  *
- * TODO module documentation here
+ * see http://www.nsnam.org/wiki/index.php/Mesh for module architectural description.
  */