add some dox doc
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon, 14 May 2007 12:34:44 +0200
changeset 616 6245a07a3c96
parent 615 ef33daff8500
child 617 b6a5451dc26b
add some dox doc
src/applications/onoff-application.h
--- a/src/applications/onoff-application.h	Mon May 14 12:33:17 2007 +0200
+++ b/src/applications/onoff-application.h	Mon May 14 12:34:44 2007 +0200
@@ -81,8 +81,20 @@
 
   void SetMaxBytes(uint32_t maxBytes);
 
+  /**
+   * \param r the data rate
+   *
+   * Set the data rate to use for every OnOffApplication for which
+   * the user does not specify an explicit data rate.
+   */
   static void SetDefaultRate(const DataRate & r);
 
+  /**
+   * \param size the packet size
+   *
+   * Set the packet size to use for every OnOffApplication for
+   * which the user does not specify an explicit packet size.
+   */
   static void SetDefaultSize (uint32_t size);
 
 protected: