ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

InterruptIn.h: Update comments

pull/8479/head
Naveen Kaje 2018-10-11 16:36:05 -05:00 committed by adbridge
parent 7126f1e2b5
commit 01448df55a
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
drivers/InterruptIn.h
View File

@ -48,6 +48,7 @@ namespace mbed {
* } * }
* *
* int main() { * int main() {
* // register trigger() to be called upon the rising edge of event
* event.rise(&trigger); * event.rise(&trigger);
* while(1) { * while(1) {
* led = !led; * led = !led;
@ -71,7 +72,10 @@ public:
* and the pin configured to the specified mode. * and the pin configured to the specified mode.
* *
* @param pin InterruptIn pin to connect to * @param pin InterruptIn pin to connect to
* @param mode The mode to set the pin to (PullUp/PullDown/etc.) * @param mode Desired Pin mode configuration.
* (Valid values could be PullNone/PullDown/PullUp/PullDefault
* See PinNames.h for your target for definitions)
*
*/ */
InterruptIn(PinName pin, PinMode mode); InterruptIn(PinName pin, PinMode mode);
@ -142,7 +146,8 @@ public:
/** Set the input pin mode /** Set the input pin mode
* *
* @param pull PullUp, PullDown, PullNone * @param pull PullUp, PullDown, PullNone, PullDefault
* See PinNames.h for your target for definitions)
*/ */
void mode(PinMode pull); void mode(PinMode pull);