mbed libraries for KL25Z
Diff: PortIn.h
- Revision:
- 8:c14af7958ef5
- Parent:
- 7:73c5efe92a6c
- Child:
- 9:663789d7729f
--- a/PortIn.h Tue Oct 23 09:20:18 2012 +0000 +++ b/PortIn.h Fri Nov 09 11:33:53 2012 +0000 @@ -4,68 +4,61 @@ #ifndef MBED_PORTIN_H #define MBED_PORTIN_H -#include "device.h" +#include "platform.h" #if DEVICE_PORTIN #include "port_api.h" -#include "platform.h" -#include "Base.h" - namespace mbed { -/* Class: PortIn - * A multiple pin digital input +/** A multiple pin digital input * * 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; - * > } - * > } - * > } + * @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); + * + * 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();