use the \valueref macro
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Thu, 15 Nov 2007 10:25:35 +0100
changeset 1854 8a3deb9c57dc
parent 1853 e2d7985a5938
child 1855 ee15fef0cb62
use the \valueref macro
src/mobility/random-direction-2d-mobility-model.h
src/mobility/random-position.h
src/mobility/random-topology.h
src/mobility/random-walk-2d-mobility-model.h
src/mobility/random-waypoint-mobility-model.h
--- a/src/mobility/random-direction-2d-mobility-model.h	Thu Nov 15 10:24:51 2007 +0100
+++ b/src/mobility/random-direction-2d-mobility-model.h	Thu Nov 15 10:25:35 2007 +0100
@@ -41,7 +41,9 @@
 {
  public:
   /**
-   * Create a default parameter object from Bind default values.
+   * Create from \valueref{RandomDirection2dSpeed},
+   * \valueref{RandomDirection2dPause}, and,
+   * \valueref{RandomDirection2dArea}.
    */
   RandomDirection2dMobilityModelParameters ();
   /**
@@ -91,7 +93,9 @@
   static const ClassId cid;
 
   /**
-   * Create a RandomDirection model from the default Bind values.
+   * Create from \valueref{RandomDirection2dSpeed},
+   * \valueref{RandomDirection2dPause}, and,
+   * \valueref{RandomDirection2dArea}.
    */
   RandomDirection2dMobilityModel ();
   /**
--- a/src/mobility/random-position.h	Thu Nov 15 10:24:51 2007 +0100
+++ b/src/mobility/random-position.h	Thu Nov 15 10:25:35 2007 +0100
@@ -54,8 +54,9 @@
 public:
   static const ClassId cid;
   /**
-   * Create a random position model based on the
-   * Bind default values.
+   * Create a random position model with construction
+   * values from \valueref{RandomRectanglePositionX}, and
+   * \valueref{RandomRectanglePositionY}
    */
   RandomRectanglePosition ();
   /**
@@ -82,8 +83,11 @@
 public:
   static const ClassId cid;
   /**
-   * Create a random position model based on the
-   * Bind default values.
+   * Create a random position model with construction
+   * values from \valueref{RandomDiscPositionTheta},
+   * \valueref{RandomDiscPositionRho}, 
+   * \valueref{RandomDiscPositionX}, and,
+   * \valueref{RandomDiscPositionY}.
    */
   RandomDiscPosition ();
   /**
--- a/src/mobility/random-topology.h	Thu Nov 15 10:24:51 2007 +0100
+++ b/src/mobility/random-topology.h	Thu Nov 15 10:25:35 2007 +0100
@@ -41,8 +41,9 @@
 {
  public:
   /**
-   * Create a default random topology based
-   * on Bind configuration.
+   * Create a default random topology with construction
+   * values from \valueref{RandomTopologyPositionType}, and,
+   * \valueref{RandomTopologyMobilityType}.
    */
   RandomTopology ();
   /**
--- a/src/mobility/random-walk-2d-mobility-model.h	Thu Nov 15 10:24:51 2007 +0100
+++ b/src/mobility/random-walk-2d-mobility-model.h	Thu Nov 15 10:25:35 2007 +0100
@@ -44,7 +44,10 @@
  public:
   /**
    * Instantiate a set of RandomWalk parameters initialized
-   * with the Bind default values.
+   * with construction values from \valueref{RandomWalk2dMode},
+   * \valueref{RandomWalk2dDistance}, \valueref{RandomWalk2dTime},
+   * \valueref{RandomWalk2dSpeed}, \valueref{RandomWalk2dDirection},
+   * and, \valueref{RandomWalk2dBounds}.
    */
   RandomWalk2dMobilityModelParameters ();
   virtual ~RandomWalk2dMobilityModelParameters ();
@@ -104,9 +107,9 @@
  * either a fixed distance has been walked or until a fixed amount
  * of time.
  *
- * The parameters of the model can be specified either with the ns3::Bind
- * function and the variables "RandomWalk2dSpeed", "RandomWalk2dMode", 
- * "RandomWalk2dDistance", "RandomWalk2dTime", and, "RandomWalk2dBounds" or
+ * The parameters of the model can be specified either with the DefaultValue::Bind
+ * function and the variables \valueref{RandomWalk2dSpeed}, \valueref{RandomWalk2dMode}, 
+ * \valueref{RandomWalk2dDistance}, \valueref{RandomWalk2dTime}, and, \valueref{RandomWalk2dBounds} or
  * with an instance of the RandomWalk2dMobilityModelParameters class which
  * must be fed to the RandomWalk2dMobilityModel constructors.
  */
@@ -115,7 +118,13 @@
  public:
   static const ClassId cid;
   /**
-   * Create a new position object located at position (0,0,0)
+   * Instantiate a set of RandomWalk parameters initialized
+   * with construction values from \valueref{RandomWalk2dMode},
+   * \valueref{RandomWalk2dDistance}, \valueref{RandomWalk2dTime},
+   * \valueref{RandomWalk2dSpeed}, \valueref{RandomWalk2dDirection},
+   * and, \valueref{RandomWalk2dBounds}.
+   *
+   * The default position is (0,0,0)
    */
   RandomWalk2dMobilityModel ();
   /**
--- a/src/mobility/random-waypoint-mobility-model.h	Thu Nov 15 10:24:51 2007 +0100
+++ b/src/mobility/random-waypoint-mobility-model.h	Thu Nov 15 10:25:35 2007 +0100
@@ -38,7 +38,8 @@
 {
 public:
   /**
-   * Defaults parameters based on the Bind values.
+   * Default parameters from \valueref{RandomWaypointPause},
+   * and, \valueref{RandomWaypointPosition}.
    */
   RandomWaypointMobilityModelParameters ();
   /**
@@ -88,7 +89,8 @@
   static const ClassId cid;
 
   /**
-   * Create a waypoint mobility model from the Bind default values.
+   * Default parameters from \valueref{RandomWaypointPause},
+   * and, \valueref{RandomWaypointPosition}.
    */
   RandomWaypointMobilityModel ();
   /**