Skip to content

Commit 3ab4f76

Browse files
Naveen KajeNaveen Kaje
authored andcommitted
InterruptIn.h: Update comments
1 parent 0235838 commit 3ab4f76

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

drivers/InterruptIn.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ namespace mbed {
4848
* }
4949
*
5050
* int main() {
51+
* // register trigger() to be called upon the rising edge of event
5152
* event.rise(&trigger);
5253
* while(1) {
5354
* led = !led;
@@ -71,7 +72,10 @@ class InterruptIn : private NonCopyable<InterruptIn> {
7172
* and the pin configured to the specified mode.
7273
*
7374
* @param pin InterruptIn pin to connect to
74-
* @param mode The mode to set the pin to (PullUp/PullDown/etc.)
75+
* @param mode Desired Pin mode configuration.
76+
* (Valid values could be PullNone/PullDown/PullUp/PullDefault
77+
* See PinNames.h for your target for definitions)
78+
*
7579
*/
7680
InterruptIn(PinName pin, PinMode mode);
7781

@@ -142,7 +146,8 @@ class InterruptIn : private NonCopyable<InterruptIn> {
142146

143147
/** Set the input pin mode
144148
*
145-
* @param pull PullUp, PullDown, PullNone
149+
* @param pull PullUp, PullDown, PullNone, PullDefault
150+
* See PinNames.h for your target for definitions)
146151
*/
147152
void mode(PinMode pull);
148153

0 commit comments

Comments
 (0)