From be743da973001d4a13b0ecdf3c11bc702f8d5510 Mon Sep 17 00:00:00 2001
From: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Date: Thu, 19 Jul 2007 12:21:48 +0200
Subject: [PATCH] more dox

---
 .../random-direction-2d-mobility-model.cc     |  4 +-
 src/node/random-direction-2d-mobility-model.h | 41 +++++++++++++++++--
 2 files changed, 39 insertions(+), 6 deletions(-)

diff --git a/src/node/random-direction-2d-mobility-model.cc b/src/node/random-direction-2d-mobility-model.cc
index 2af5e792c..33a10e820 100644
--- a/src/node/random-direction-2d-mobility-model.cc
+++ b/src/node/random-direction-2d-mobility-model.cc
@@ -28,11 +28,9 @@
 namespace ns3 {
 
 const double RandomDirection2dMobilityModel::PI = 3.1415;
-const InterfaceId RandomDirection2dMobilityModel::iid = 
-  MakeInterfaceId ("RandomDirection2dMobilityModel", MobilityModel::iid);
 const ClassId RandomDirection2dMobilityModel::cid = 
   MakeClassId<RandomDirection2dMobilityModel> ("RandomDirection2dMobilityModel",
-                                             RandomDirection2dMobilityModel::iid);
+                                               MobilityModel::iid);
 
 
 static RandomVariableDefaultValue 
diff --git a/src/node/random-direction-2d-mobility-model.h b/src/node/random-direction-2d-mobility-model.h
index db1f840aa..fa5b64739 100644
--- a/src/node/random-direction-2d-mobility-model.h
+++ b/src/node/random-direction-2d-mobility-model.h
@@ -34,17 +34,37 @@ namespace ns3 {
 
 class RandomVariable;
 
+/**
+ * \brief the parameters to control a RandomDirection mobility model.
+ */
 class RandomDirection2dParameters : public Object
 {
  public:
+  /**
+   * Create a default parameter object from Bind default values.
+   */
   RandomDirection2dParameters ();
+  /**
+   * \param bounds the 2d bounds of the mobility model
+   * \param speedVariable the random variable used to pick a random speed
+   * \param pauseVariable the random variable used to pick a random pause delay
+   */
   RandomDirection2dParameters (const Rectangle &bounds,
-			     const RandomVariable &speedVariable,
-			     const RandomVariable &pauseVariable);
+                               const RandomVariable &speedVariable,
+                               const RandomVariable &pauseVariable);
   virtual ~RandomDirection2dParameters ();
 
+  /**
+   * \param speedVariable the random variable used to pick a random speed.
+   */
   void SetSpeed (const RandomVariable &speedVariable);
+  /**
+   * \param pauseVariable the random variable used to pick a random pause delay.
+   */
   void SetPause (const RandomVariable &pauseVariable);
+  /**
+   * \param bounds the 2d bounds of the mobility model.
+   */
   void SetBounds (const Rectangle &bounds);
  private:
   friend class RandomDirection2dMobilityModel;
@@ -56,13 +76,28 @@ class RandomDirection2dParameters : public Object
   RandomVariable *m_pauseVariable;
 };
 
+/**
+ * \brief a RandomDirection mobility model
+ *
+ * The movement of objects is based on random directions: each object
+ * pauses for a specific delay, chooses a random direction and speed and 
+ * then travels in the specific direction until it reaches one of
+ * the boundaries of the model. When it reaches the boundary, it pauses,
+ * selects a new direction and speed, aso.
+ */
 class RandomDirection2dMobilityModel : public MobilityModel
 {
  public:
-  static const InterfaceId iid;
   static const ClassId cid;
 
+  /**
+   * Create a RandomDirection model from the default Bind values.
+   */
   RandomDirection2dMobilityModel ();
+  /**
+   * \param parameters the parameters which control the behavior of the model.
+   * Create a RandomDirection model using the parameters specified.
+   */
   RandomDirection2dMobilityModel (Ptr<RandomDirection2dParameters> parameters);
  private:
   void Start (void);