Diff: BusInOut.h

Revision:

43:aff670d0d510

Parent:

27:7110ebee3484

diff -r cd19af002ccc -r aff670d0d510 BusInOut.h
--- a/BusInOut.h	Wed Aug 29 12:44:47 2012 +0100
+++ b/BusInOut.h	Wed Oct 24 10:44:49 2012 +0000
@@ -13,25 +13,20 @@
 
 namespace mbed {
 
-/* Class: BusInOut
- *  A digital input output bus, used for setting the state of a collection of pins
+/** A digital input output bus, used for setting the state of a collection of pins
  */
 class BusInOut : public Base {
 
 public:
 
-    /* Group: Configuration Methods */
-	
-    /* Constructor: BusInOut
-     *  Create an BusInOut, connected to the specified pins
+    /** Create an BusInOut, connected to the specified pins
+     *
+     *  @param p<n> DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
      *
-     * Variables:
-     *  p<n> - DigitalInOut pin to connect to bus bit p<n> (p5-p30, NC)
-     *
-     * Note:
-     *  It is only required to specify as many pin variables as is required
-     *  for the bus; the rest will default to NC (not connected)
-   	 */ 
+     *  @note
+     *    It is only required to specify as many pin variables as is required
+     *    for the bus; the rest will default to NC (not connected)
+     */ 
     BusInOut(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
              PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
              PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
@@ -43,53 +38,42 @@
     virtual ~BusInOut();
 
     /* Group: Access Methods */
-		
-    /* Function: write
-     *  Write the value to the output bus
+        
+    /** Write the value to the output bus
      *
-     * Variables:
-     *  value - An integer specifying a bit to write for every corresponding DigitalInOut pin
+     *  @param value An integer specifying a bit to write for every corresponding DigitalInOut pin
      */
     void write(int value);
 
-		
-    /* Function: read
-     *  Read the value currently output on the bus
+        
+    /** Read the value currently output on the bus
      *
-     * Variables:
-     *  returns - An integer with each bit corresponding to associated DigitalInOut pin setting
+     *  @returns
+     *    An integer with each bit corresponding to associated DigitalInOut pin setting
      */
     int read();
 
-    /* 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
+     *  @param mode PullUp, PullDown, PullNone
      */
     void mode(PinMode pull);
  
 #ifdef MBED_OPERATORS
-    /* Group: Access Method Shorthand */
-	   
-   	/* Function: operator=
-     *  A shorthand for <write>
+     /** A shorthand for write()
      */
     BusInOut& operator= (int v);
     BusInOut& operator= (BusInOut& rhs);
 
-    /* Function: operator int()
-     *  A shorthand for <read>
+    /** A shorthand for read()
      */
     operator int();
 #endif
@@ -106,7 +90,7 @@
 #ifdef MBED_RPC
     static void construct(const char *arguments, char *res);
 #endif
-			
+            
 };
 
 } // namespace mbed