fix dox warning
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Wed, 08 Aug 2007 12:34:18 +0200
changeset 1250 243eb985ad00
parent 1249 94a1eddc8196
child 1251 7ebf9949201e
fix dox warning
src/core/callback.h
src/core/random-variable.h
src/node/ipv4-address.h
src/simulator/scheduler.h
--- a/src/core/callback.h	Wed Aug 08 12:33:33 2007 +0200
+++ b/src/core/callback.h	Wed Aug 08 12:34:18 2007 +0200
@@ -358,7 +358,7 @@
 
 /**
  * \ingroup MakeCallback
- * \param mem_ptr class method member pointer
+ * \param memPtr class method member pointer
  * \param objPtr class instance
  * \return a wrapper Callback
  * Build Callbacks for class method members which takes no arguments
--- a/src/core/random-variable.h	Wed Aug 08 12:33:33 2007 +0200
+++ b/src/core/random-variable.h	Wed Aug 08 12:34:18 2007 +0200
@@ -772,6 +772,7 @@
   /**
    * \param s Low end of the range
    * \param l High end of the range
+   * \param mean mean of the distribution
    * \return A triangularly distributed random number between s and l
    */
   static double GetSingleValue(double s, double l, double mean);
--- a/src/node/ipv4-address.h	Wed Aug 08 12:33:33 2007 +0200
+++ b/src/node/ipv4-address.h	Wed Aug 08 12:34:18 2007 +0200
@@ -116,7 +116,7 @@
    * (bitwise and) with a network mask, yielding an IPv4 network
    * address.
    *
-   * \param a network mask 
+   * \param mask a network mask 
    */
   Ipv4Address CombineMask (Ipv4Mask const &mask) const;
 
--- a/src/simulator/scheduler.h	Wed Aug 08 12:33:33 2007 +0200
+++ b/src/simulator/scheduler.h	Wed Aug 08 12:34:18 2007 +0200
@@ -58,9 +58,7 @@
   virtual ~Scheduler () = 0;
 
   /**
-   * \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 event to store in the event list
    *
    * This method takes ownership of the event pointer.
    */
@@ -83,9 +81,8 @@
   virtual EventId RemoveNext (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 id was found and removed 
+   *          successfully, false otherwise.
    *
    * This methods cannot be invoked if the list is empty.
    */