diff options
author | Marti Bolivar <mbolivar@leaflabs.com> | 2012-08-14 11:32:47 -0400 |
---|---|---|
committer | Marti Bolivar <mbolivar@leaflabs.com> | 2012-08-14 11:32:47 -0400 |
commit | 276baf8d43a9a4fd4a7296707715b028cf64f564 (patch) | |
tree | 5e99bae549293c1ea0866f2c6c783345c5bdd0c1 /wirish/include | |
parent | 2618fc5b698f1ac779e85b2994e362a547f82d6e (diff) | |
download | librambutan-276baf8d43a9a4fd4a7296707715b028cf64f564.tar.gz librambutan-276baf8d43a9a4fd4a7296707715b028cf64f564.zip |
wirish/ext_interrupts.h: Doxygen
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'wirish/include')
-rw-r--r-- | wirish/include/wirish/ext_interrupts.h | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/wirish/include/wirish/ext_interrupts.h b/wirish/include/wirish/ext_interrupts.h index 03b8e97..9ef4657 100644 --- a/wirish/include/wirish/ext_interrupts.h +++ b/wirish/include/wirish/ext_interrupts.h @@ -41,12 +41,12 @@ */ typedef enum ExtIntTriggerMode { RISING, /**< To trigger an interrupt when the pin transitions LOW - to HIGH */ + to HIGH */ FALLING, /**< To trigger an interrupt when the pin transitions - HIGH to LOW */ + HIGH to LOW */ CHANGE /**< To trigger an interrupt when the pin transitions from - LOW to HIGH or HIGH to LOW (i.e., when the pin - changes). */ + LOW to HIGH or HIGH to LOW (i.e., when the pin + changes). */ } ExtIntTriggerMode; /** @@ -57,9 +57,10 @@ typedef enum ExtIntTriggerMode { * context. The new handler will replace whatever handler is * currently registered for the pin, if any. * - * @param pin Maple pin number + * @param pin Pin number * @param handler Function to run upon external interrupt trigger. - * The handler should take no arguments, and have void return type. + * The handler should take no arguments, and have void + * return type. * @param mode Type of transition to trigger on, e.g. falling, rising, etc. * * @sideeffect Registers a handler |