Diff: Timeout.h

Revision:

43:aff670d0d510

Parent:

27:7110ebee3484

diff -r cd19af002ccc -r aff670d0d510 Timeout.h
--- a/Timeout.h	Wed Aug 29 12:44:47 2012 +0100
+++ b/Timeout.h	Wed Oct 24 10:44:49 2012 +0000
@@ -9,80 +9,73 @@
 
 namespace mbed {
 
-/* Class: Timeout
- *  A Timeout is used to call a function at a point in the future
+/** A Timeout is used to call a function at a point in the future
  *
- * You can use as many seperate Timeout objects as you require. 
+ *  You can use as many seperate Timeout objects as you require. 
  *
  * Example:
- * > // Blink until timeout.
- * >
- * > #include "mbed.h"
- * > 
- * > Timeout timeout;
- * > DigitalOut led(LED1);
- * > 
- * > int on = 1;
- * > 
- * > void attimeout() {
- * >     on = 0;
- * > }
- * > 
- * > int main() {
- * >     timeout.attach(&attimeout, 5);
- * >     while(on) {
- * >         led = !led;
- * >         wait(0.2);
- * >     }
- * > }
+ * @code
+ * // Blink until timeout.
+ *
+ * #include "mbed.h"
+ * 
+ * Timeout timeout;
+ * DigitalOut led(LED1);
+ * 
+ * int on = 1;
+ * 
+ * void attimeout() {
+ *     on = 0;
+ * }
+ * 
+ * int main() {
+ *     timeout.attach(&attimeout, 5);
+ *     while(on) {
+ *         led = !led;
+ *         wait(0.2);
+ *     }
+ * }
+ * @endcode
  */
 class Timeout : public Ticker {
 
 #if 0 // For documentation
 
-    /* Function: attach
-     *  Attach a function to be called by the Timeout, specifiying the delay in seconds
+    /** Attach a function to be called by the Timeout, specifiying the delay in seconds
      *     
-     * Variables:
-     *  fptr - pointer to the function to be called
-     *  t - the time before the call in seconds
+     *  @param fptr pointer to the function to be called
+     *  @param t the time before the call in seconds
      */
     void attach(void (*fptr)(void), float t) {
         attach_us(fptr, t * 1000000.0f);
     }
     
-    /* Function: attach
-     *  Attach a member function to be called by the Timeout, specifiying the delay in seconds
+    /** Attach a member function to be called by the Timeout, specifiying the delay in seconds
      *     
-     * Variables:
-     *  tptr - pointer to the object to call the member function on
-     *  mptr - pointer to the member function to be called
-     *  t - the time before the calls in seconds
+     *  @param tptr pointer to the object to call the member function on
+     *  @param mptr pointer to the member function to be called
+     *  @param t the time before the calls in seconds
      */
     template<typename T>
     void attach(T* tptr, void (T::*mptr)(void), float t) {
         attach_us(tptr, mptr, t * 1000000.0f);
     }
     
-    /* Function: attach_us
-     *  Attach a function to be called by the Timeout, specifiying the delay in micro-seconds
+    /** Attach a function to be called by the Timeout, specifiying the delay in micro-seconds
      *     
-     * Variables:
-     *  fptr - pointer to the function to be called
-     *  t - the time before the call in micro-seconds
+     *  @param fptr pointer to the function to be called
+     *  @param t the time before the call in micro-seconds
      */
     void attach_us(void (*fptr)(void), unsigned int t) {
         _function.attach(fptr);
         setup(t);
     }
 
-    /* Function: attach_us
-     *  Attach a member function to be called by the Timeout, specifiying the delay in micro-seconds
+    /** Attach a member function to be called by the Timeout, specifiying the delay in micro-seconds
      *     
-     * Variables:
-     *  tptr - pointer to the object to call the member function on
-     *  mptr - pointer to the member function to be called
-     *  t - the time before the call in micro-seconds
+     *  @param tptr pointer to the object to call the member function on
+     *  @param mptr pointer to the member function to be called
+     *  @param t the time before the call in micro-seconds
      */    
     template<typename T>
     void attach_us(T* tptr, void (T::*mptr)(void), unsigned int t) {
@@ -90,8 +83,7 @@
         setup(t);
     }
     
-    /* Function: detach
-     *  Detach the function
+    /** Detach the function
      */        
     void detach();