use valueref where needed.
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon, 29 Oct 2007 14:45:43 +0100
changeset 2045 d44a90e4c03f
parent 2044 1ae23139a536
child 2046 7a9113c1b0c1
use valueref where needed.
src/devices/wifi/propagation-loss-model.h
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/devices/wifi/propagation-loss-model.h	Mon Oct 29 14:40:25 2007 +0100
+++ b/src/devices/wifi/propagation-loss-model.h	Mon Oct 29 14:45:43 2007 +0100
@@ -50,7 +50,7 @@
 
   /**
    * \returns the default propagation loss model as specified
-   * by the PropagationLossModelType ns3::DefaultValue.
+   * by \valueref{PropagationLossModelType}.
    */
   static Ptr<PropagationLossModel> CreateDefault (void);
 };
@@ -62,7 +62,7 @@
 {
 public:
   /**
-   * Use the default parameters from RandomPropagation.
+   * Use the default parameters from \valueref{RandomPropagationLossDistribution}.
    */
   RandomPropagationLossModel ();
   /**
@@ -88,7 +88,8 @@
 {
 public:
   /**
-   * Use the default parameters from \valueref{FriisPropagationLambda}.
+   * Use the default parameters from \valueref{FriisPropagationLossLambda},
+   * and \valueref{FriisPropagationLossSystemLoss}.
    */
   FriisPropagationLossModel ();
   /**
@@ -143,8 +144,8 @@
 public:
   /**
    * Use the default parameters from
-   * PathLossPropagationExponent, and,
-   * PathLossPropagationReferenceType
+   * \valueref{PathLossPropagationLossExponent}, and,
+   * \valueref{PathLossPropagationLossReferenceType}
    * to create a new propagation loss model.
    */
   PathLossPropagationLossModel ();
--- a/src/mobility/random-direction-2d-mobility-model.h	Mon Oct 29 14:40:25 2007 +0100
+++ b/src/mobility/random-direction-2d-mobility-model.h	Mon Oct 29 14:45:43 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	Mon Oct 29 14:40:25 2007 +0100
+++ b/src/mobility/random-position.h	Mon Oct 29 14:45:43 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	Mon Oct 29 14:40:25 2007 +0100
+++ b/src/mobility/random-topology.h	Mon Oct 29 14:45:43 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	Mon Oct 29 14:40:25 2007 +0100
+++ b/src/mobility/random-walk-2d-mobility-model.h	Mon Oct 29 14:45:43 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 ();
@@ -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	Mon Oct 29 14:40:25 2007 +0100
+++ b/src/mobility/random-waypoint-mobility-model.h	Mon Oct 29 14:45:43 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 ();
   /**