Diff: DigitalIn.h

Revision:

8:c14af7958ef5

Parent:

0:8024c367e29f

Child:

9:663789d7729f

--- a/DigitalIn.h	Tue Oct 23 09:20:18 2012 +0000
+++ b/DigitalIn.h	Fri Nov 09 11:33:53 2012 +0000
@@ -5,75 +5,62 @@
 #define MBED_DIGITALIN_H
 
 #include "platform.h"
-#include "Base.h"
 
 #include "gpio_api.h"
 
 namespace mbed {
 
-/* Class: DigitalIn
- *  A digital input, used for reading the state of a pin
+/** A digital input, used for reading the state of a pin
  *
  * Example:
- * > // Flash an LED while a DigitalIn is true
- * >
- * > #include "mbed.h"
- * >
- * > DigitalIn enable(p5);
- * > DigitalOut led(LED1);
- * >
- * > int main() {
- * >     while(1) {
- * >         if(enable) {
- * >             led = !led;
- * >         }
- * >         wait(0.25);
- * >     }
- * > }
+ * @code
+ * // Flash an LED while a DigitalIn is true
+ * 
+ * #include "mbed.h"
+ * 
+ * DigitalIn enable(p5);
+ * DigitalOut led(LED1);
+ * 
+ * int main() {
+ *     while(1) {
+ *         if(enable) {
+ *             led = !led;
+ *         }
+ *         wait(0.25);
+ *     }
+ * }
+ * @endcode
  */
-class DigitalIn : public Base {
+class DigitalIn {
 
 public:
-
-    /* Constructor: DigitalIn
-     *  Create a DigitalIn connected to the specified pin
+    /** Create a DigitalIn connected to the specified pin
      *
-     * Variables:
-     *  pin - DigitalIn pin to connect to
-     *  name - (optional) A string to identify the object
+     *  @param pin DigitalIn pin to connect to
+     *  @param name (optional) A string to identify the object
      */
-    DigitalIn(PinName pin, const char *name = NULL);
+    DigitalIn(PinName pin);
     
-    /* Function: read
-     *  Read the input, represented as 0 or 1 (int)
+    /** Read the input, represented as 0 or 1 (int)
      *
-     * Variables:
-     *  returns - An integer representing the state of the input pin, 
-     *      0 for logical 0 and 1 for logical 1
+     *  @returns
+     *    An integer representing the state of the input pin, 
+     *    0 for logical 0, 1 for logical 1
      */
     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 pull);
     
 #ifdef MBED_OPERATORS
-    /* Function: operator int()
-     *  An operator shorthand for <read()>
+    /** An operator shorthand for read()
      */
     operator int() {
         return read();
     }
-
-#endif
-
-#ifdef MBED_RPC
-    virtual const struct rpc_method *get_rpc_methods();
-    static struct rpc_class *get_rpc_class();
 #endif
 
 protected:
@@ -83,4 +70,3 @@
 } // namespace mbed
 
 #endif
-