From ba41fce14ca9b534285250c2c73985ce80b7d976 Mon Sep 17 00:00:00 2001
From: Pavel Boyko <boyko@iitp.ru>
Date: Mon, 2 Aug 2010 13:16:57 +0400
Subject: [PATCH] Mobility doxygen: all classes are documented and added to the
 mobility module. All public methods and fields should follow.

---
 doc/modules                      |  2 ++
 src/helper/mobility-helper.h     | 14 ++++++--------
 src/helper/ns2-mobility-helper.h | 20 +++++++++++---------
 src/mobility/mobility.h          |  5 ++++-
 4 files changed, 23 insertions(+), 18 deletions(-)

diff --git a/doc/modules b/doc/modules
index a1d237bce..b7417e476 100644
--- a/doc/modules
+++ b/doc/modules
@@ -55,6 +55,8 @@
  * 
  * @defgroup applications Applications
  *
+ * @defgroup mobility Mobility
+ *
  * @defgroup constants Constants
  * @brief Constants you can change
  *
diff --git a/src/helper/mobility-helper.h b/src/helper/mobility-helper.h
index 4a7eb4062..f66b4e3c3 100644
--- a/src/helper/mobility-helper.h
+++ b/src/helper/mobility-helper.h
@@ -33,7 +33,8 @@ class PositionAllocator;
 class MobilityModel;
 
 /**
- * \brief assign positions and mobility models to nodes.
+ * \ingroup mobility
+ * \brief Helper class used to assign positions and mobility models to nodes.
  *
  * MobilityHelper::Install is the most important method here.
  */
@@ -172,14 +173,13 @@ public:
   void PopReferenceMobilityModel (void);
 
   /**
-   * \returns a string which contains the TypeId of the currently-selected
+   * \return a string which contains the TypeId of the currently-selected
    *          mobility model.
    */
   std::string GetMobilityModelType (void) const;
 
   /**
-   * \brief "Layout" a single node according to the current position allocator
-   * type.
+   * \brief "Layout" a single node according to the current position allocator type.
    *
    * This method creates an instance of a ns3::MobilityModel subclass (the 
    * type of which was set with MobilityHelper::SetMobilityModel), aggregates
@@ -190,8 +190,7 @@ public:
    */
   void Install (Ptr<Node> node) const;
   /**
-   * \brief "Layout" a single node according to the current position allocator
-   * type.
+   * \brief "Layout" a single node according to the current position allocator type.
    *
    * This method creates an instance of a ns3::MobilityModel subclass (the 
    * type of which was set with MobilityHelper::SetMobilityModel), aggregates
@@ -203,8 +202,7 @@ public:
   void Install (std::string nodeName) const;
 
   /**
-   * \brief Layout a collection of nodes according to the current position allocator
-   * type.
+   * \brief Layout a collection of nodes according to the current position allocator type.
    *
    * For each node in the provided NodeContainer, this method creates an instance 
    * of a ns3::MobilityModel subclass (the type of which was set with 
diff --git a/src/helper/ns2-mobility-helper.h b/src/helper/ns2-mobility-helper.h
index 7186e5375..3e9e350a6 100644
--- a/src/helper/ns2-mobility-helper.h
+++ b/src/helper/ns2-mobility-helper.h
@@ -33,20 +33,22 @@ namespace ns3 {
 class ConstantVelocityMobilityModel;
 
 /**
- * \brief A helper which can read ns-2 movement files and configure nodes mobility.
+ * \ingroup mobility
+ * \brief Helper class which can read ns-2 movement files and configure nodes mobility.
  * 
  * This implementation is based on the ns2 movement documentation of ns2
  * as described in http://www.isi.edu/nsnam/ns/doc/node174.html
  *
  * Valid trace files use the following ns2 statements:
- *
- * $node set X_ x1
- * $node set Y_ y1
- * $node set Z_ z1
- * $ns at $time $node setdest x2 y2 speed
- * $ns at $time $node set X_ x1
- * $ns at $time $node set Y_ Y1
- * $ns at $time $node set Z_ Z1
+ \verbatim
+   $node set X_ x1
+   $node set Y_ y1
+   $node set Z_ z1
+   $ns at $time $node setdest x2 y2 speed
+   $ns at $time $node set X_ x1
+   $ns at $time $node set Y_ Y1
+   $ns at $time $node set Z_ Z1
+ \endverbatim
  *
  * Following tools are known to support this format:
  *  - BonnMotion http://net.cs.uni-bonn.de/wg/cs/applications/bonnmotion/
diff --git a/src/mobility/mobility.h b/src/mobility/mobility.h
index ee51dc01c..e09b6d4db 100644
--- a/src/mobility/mobility.h
+++ b/src/mobility/mobility.h
@@ -1,5 +1,5 @@
 /**
- * \defgroup mobility Mobility
+ * \addtogroup mobility Mobility
  *
  * The mobility support includes:
  *  - a set of mobility models which are used to track and maintain
@@ -7,4 +7,7 @@
  *
  *  - a "course change notifier" trace source which can be used to register
  *    listeners to the course changes of a mobility model
+ * 
+ *  - a number of helper classes which are used to place nodes and setup 
+ *    mobility models (including parsers for some mobility definition formats).
  */