--- a/src/mobility/grid-topology.h Thu Jul 19 13:02:02 2007 +0200
+++ b/src/mobility/grid-topology.h Thu Jul 19 13:11:08 2007 +0200
@@ -42,7 +42,7 @@
*
* The first object is positioned at (xMin,yMin).
*/
- GridTopology (double xMin, double yMin, uint32_t nCols, double deltaX, double deltaY);
+ GridTopology (double xMin, double yMin, uint32_t n, double deltaX, double deltaY);
/**
* \param classId the classId of the position object to attach to each
@@ -51,11 +51,12 @@
void SetMobilityModel (ClassId classId);
/**
- * \param objects a vector of objects
+ * \param begin an iterator to the first object to layout.
+ * \param end an iterator to the last object to layout.
*
* Attach a position (the type of position is specified through
- * the ClassId given to SetMobilityModelModel) to each object present
- * in the input vector and configure its initial location with a set
+ * the ClassId given to SetMobilityModelModel) to each input object
+ * and configure its initial location with a set
* of coordinates arranged according to a regular rectangular grid,
* one row after the other.
*/
@@ -63,11 +64,12 @@
void LayoutRowFirst (const T &begin, const T &end);
/**
- * \param objects a vector of objects
+ * \param begin an iterator to the first object to layout.
+ * \param end an iterator to the last object to layout.
*
* Attach a position (the type of position is specified through
- * the ClassId given to SetMobilityModelModel) to each object present
- * in the input vector and configure its initial location with a set
+ * the ClassId given to SetMobilityModelModel) to each input object
+ * and configure its initial location with a set
* of coordinates arranged according to a regular rectangular grid,
* one column after the other.
*/
--- a/src/mobility/random-topology.h Thu Jul 19 13:02:02 2007 +0200
+++ b/src/mobility/random-topology.h Thu Jul 19 13:11:08 2007 +0200
@@ -48,7 +48,7 @@
/**
* \param positionModel model to set the initial position
* of each object.
- * \param type of mobility model to attach to each object.
+ * \param mobilityModel type of mobility model to attach to each object.
*
* Create a random topology based on the
* specified position and mobility models.
--- a/src/mobility/rectangle.h Thu Jul 19 13:02:02 2007 +0200
+++ b/src/mobility/rectangle.h Thu Jul 19 13:11:08 2007 +0200
@@ -39,10 +39,10 @@
BOTTOM
};
/**
- * \param xMin x coordinates of left boundary.
- * \param xMax x coordinates of right boundary.
- * \param yMin y coordinates of bottom boundary.
- * \param yMin y coordinates of top boundary.
+ * \param _xMin x coordinates of left boundary.
+ * \param _xMax x coordinates of right boundary.
+ * \param _yMin y coordinates of bottom boundary.
+ * \param _yMax y coordinates of top boundary.
*
* Create a rectangle.
*/
--- a/src/simulator/scheduler.h Thu Jul 19 13:02:02 2007 +0200
+++ b/src/simulator/scheduler.h Thu Jul 19 13:11:08 2007 +0200
@@ -68,11 +68,8 @@
private:
/**
- * \param event event to store in the event list
- * \param key timecode associated to this new event
- * \returns an event id which identifies the event inserted
+ * \param id the event id to store.
*
- * This method takes ownership of the event pointer.
*/
virtual void RealInsert (EventId id) = 0;
/**
@@ -80,8 +77,7 @@
*/
virtual bool RealIsEmpty (void) const = 0;
/**
- * \returns a pointer to the next earliest event. The caller
- * takes ownership of the returned pointer.
+ * \returns a the next earliest event.
*
* This method cannot be invoked if the list is empty.
*/
@@ -93,9 +89,8 @@
virtual void RealRemoveNext (void) = 0;
/**
* \param id the id of the event to remove
- * \param key the timecode of the event removed
- * \returns a pointer to the event removed. The caller
- * takes ownership of the returned pointer.
+ * \returns true if the event was found and removed
+ * successfully, false otherwise.
*
* This methods cannot be invoked if the list is empty.
*/