From 01448df55ad06f8fa26a9e15d538f86f0e4501f6 Mon Sep 17 00:00:00 2001 From: Naveen Kaje Date: Thu, 11 Oct 2018 16:36:05 -0500 Subject: [PATCH] InterruptIn.h: Update comments --- drivers/InterruptIn.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/drivers/InterruptIn.h b/drivers/InterruptIn.h index 0558cc5540..e15a20e02b 100644 --- a/drivers/InterruptIn.h +++ b/drivers/InterruptIn.h @@ -48,6 +48,7 @@ namespace mbed { * } * * int main() { + * // register trigger() to be called upon the rising edge of event * event.rise(&trigger); * while(1) { * led = !led; @@ -71,7 +72,10 @@ public: * and the pin configured to the specified mode. * * @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); @@ -142,7 +146,8 @@ public: /** 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);