diff options
author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-25 01:53:29 -0400 |
---|---|---|
committer | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-26 02:42:07 -0400 |
commit | 0dbb4829963a88a84a4387e8c9dc7ce94482a28b (patch) | |
tree | cdb17c7fa404ea7e5b4bee3674705acaaef44095 /docs/source/lang/api/toggleled.rst | |
parent | 6bf24f14a33b7e6d4565cd147ad4d2252dba77ff (diff) | |
download | librambutan-0dbb4829963a88a84a4387e8c9dc7ce94482a28b.tar.gz librambutan-0dbb4829963a88a84a4387e8c9dc7ce94482a28b.zip |
Docs: Move toggleLED() and waitForButtonPress() examples.
These two examples from board-values.rst really belong in the
documentation for the functions they reference.
Diffstat (limited to 'docs/source/lang/api/toggleled.rst')
-rw-r--r-- | docs/source/lang/api/toggleled.rst | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/docs/source/lang/api/toggleled.rst b/docs/source/lang/api/toggleled.rst index 54a7d64..cad347f 100644 --- a/docs/source/lang/api/toggleled.rst +++ b/docs/source/lang/api/toggleled.rst @@ -1,15 +1,35 @@ +.. highlight:: cpp + .. _lang-toggleled: toggleLED() =========== -Switches the LED from off to on, or on to off. +*Toggle* the built-in LED: switch it from off to on, or on to off. Library Documentation --------------------- .. doxygenfunction:: toggleLED +Example +------- + +.. _lang-toggleled-example: + +This example sets up the board's LED pin for output, then toggles the +LED every 100 milliseconds:: + + void setup() { + pinMode(BOARD_LED_PIN, OUTPUT); + } + + void loop() { + toggleLED(); + delay(100); + } + + See Also -------- |