mbed libraries for KL25Z
Diff: DigitalInOut.h
- Revision:
- 8:c14af7958ef5
- Parent:
- 2:e9a661555b58
- Child:
- 9:663789d7729f
--- a/DigitalInOut.h Tue Oct 23 09:20:18 2012 +0000 +++ b/DigitalInOut.h Fri Nov 09 11:33:53 2012 +0000 @@ -5,65 +5,53 @@ #define MBED_DIGITALINOUT_H #include "platform.h" -#include "Base.h" #include "gpio_api.h" 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 { +class DigitalInOut { 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); + DigitalInOut(PinName pin); - /* 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); - /* 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(); - /* 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); @@ -75,23 +63,17 @@ return *this; } - /* Function: operator int() - * A shorthand for <read> + /** A 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: gpio_object gpio; }; -} // namespace mbed +} // namespace mbed -#endif +#endif