Diff: PortIn.h

Revision:

43:e2ed12d17f06

Parent:

28:667d61c9177b

Child:

44:24d45a770a51

diff -r cd19af002ccc -r e2ed12d17f06 PortIn.h
--- a/PortIn.h	Wed Aug 29 12:44:47 2012 +0100
+++ b/PortIn.h	Fri Oct 26 17:40:46 2012 +0100
@@ -14,61 +14,56 @@
 
 namespace mbed {
 
-/* Class: PortIn
- *  A multiple pin digital input
+/** A multiple pin digital input
+ *
+ * Example:
+ * @code
+ * // Switch on an LED if any of mbed pins 21-26 is high
+ *
+ * #include "mbed.h"
+ *
+ * PortIn     p(Port2, 0x0000003F);   // p21-p26
+ * DigitalOut ind(LED4);
  *
- *  Example:
- *  > // Switch on an LED if any of mbed pins 21-26 is high
- *  >
- *  > #include "mbed.h"
- *  >
- *  > PortIn     p(Port2, 0x0000003F);   // p21-p26
- *  > DigitalOut ind(LED4);
- *  >
- *  > int main() {
- *  >     while(1) {
- *  >         int pins = p.read();
- *  >         if(pins) {
- *  >             ind = 1;
- *  >         } else {
- *  >             ind = 0;
- *  >         }
- *  >     }
- *  > }
+ * int main() {
+ *     while(1) {
+ *         int pins = p.read();
+ *         if(pins) {
+ *             ind = 1;
+ *         } else {
+ *             ind = 0;
+ *         }
+ *     }
+ * }
+ * @endcode
  */
 class PortIn {
 public:
 
-    /* Constructor: PortIn
-     *  Create an PortIn, connected to the specified port
+    /** Create an PortIn, connected to the specified port
      *
-     * Variables:
-     *  port - Port to connect to (Port0-Port5)
-     *  mask - A bitmask to identify which bits in the port should be included (0 - ignore)
-   	 */ 
+     *  @param port Port to connect to (Port0-Port5)
+     *  @param mask A bitmask to identify which bits in the port should be included (0 - ignore)
+     */ 
     PortIn(PortName port, int mask = 0xFFFFFFFF);
 
-    /* Function: read
-     *  Read the value currently output on the port
+    /** Read the value currently output on the port
      *
-     * Variables:
-     *  returns - An integer with each bit corresponding to associated port pin setting
+     *  @returns
+     *    An integer with each bit corresponding to associated port pin setting
      */
     int read();
 
-    /* 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 mode);
     
-    /* Function: operator int()
-     *  A shorthand for <read>
+    /** A shorthand for read()
      */
     operator int() { 
-	    return read();
+        return read();
     }
 
 private: