Diff: DigitalInOut.h

Revision:

43:aff670d0d510

Parent:

27:7110ebee3484

--- a/DigitalInOut.h	Wed Aug 29 12:44:47 2012 +0100
+++ b/DigitalInOut.h	Wed Oct 24 10:44:49 2012 +0000
@@ -12,27 +12,22 @@
 
 namespace mbed {
 
-/* Class: DigitalInOut
- *  A digital input/output, used for setting or reading a bi-directional pin
+/** A digital input/output, used for setting or reading a bi-directional pin
  */
 class DigitalInOut : public Base {
 
 public:
 
-    /* Constructor: DigitalInOut
-     *  Create a DigitalInOut connected to the specified pin
+    /** Create a DigitalInOut connected to the specified pin
      *
-     * Variables:
-     *  pin - DigitalInOut pin to connect to
+     *  @param pin DigitalInOut pin to connect to
      */
     DigitalInOut(PinName pin, const char* name = NULL);
 
-    /* Function: write
-     *  Set the output, specified as 0 or 1 (int)
+    /** Set the output, specified as 0 or 1 (int)
      *
-     * Variables:
-     *  value - An integer specifying the pin output value, 
-     *      0 for logical 0 and 1 (or any other non-zero value) for logical 1 
+     *  @param value An integer specifying the pin output value, 
+     *      0 for logical 0, 1 (or any other non-zero value) for logical 1 
      */
     void write(int value) {
 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
@@ -53,12 +48,11 @@
 #endif
     }
 
-    /* Function: read
-     *  Return the output setting, represented as 0 or 1 (int)
+    /** Return the output setting, represented as 0 or 1 (int)
      *
-     * Variables:
-     *  returns - An integer representing the output setting of the pin if it is an output, 
-     *      or read the input if set as an input
+     *  @returns
+     *    an integer representing the output setting of the pin if it is an output, 
+     *    or read the input if set as an input
      */
     int read() {
 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
@@ -70,27 +64,22 @@
     }
 
 
-    /* Function: output
-     *  Set as an output
+    /** Set as an output
      */
     void output();
 
-    /* Function: input
-     *  Set as an input
+    /** Set as an input
      */
     void input();
 
-    /* Function: mode
-     *  Set the input pin mode
+    /** Set the input pin mode
      *
-     * Variables:
-     *  mode - PullUp, PullDown, PullNone, OpenDrain
+     *  @param mode PullUp, PullDown, PullNone, OpenDrain
      */
     void mode(PinMode pull);
     
 #ifdef MBED_OPERATORS
-    /* Function: operator=
-     *  A shorthand for <write>
+    /** A shorthand for write()
      */
     DigitalInOut& operator= (int value) {
         write(value);
@@ -102,8 +91,7 @@
         return *this;
     }
 
-    /* Function: operator int()
-     *  A shorthand for <read>
+    /** A shorthand for read()
      */
     operator int() {
         return read();