Doxygen cleanup

This commit is contained in:
Pavel Boyko
2009-04-13 09:33:58 +04:00
parent a67a74a345
commit 691551c2e5
3 changed files with 24 additions and 13 deletions

View File

@@ -29,8 +29,10 @@ namespace ns3 {
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 @@ private:
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 ();

View File

@@ -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.
*/

View File

@@ -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.
*/