aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/digitalwrite.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/lang/api/digitalwrite.rst
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz
librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'docs/source/lang/api/digitalwrite.rst')
-rw-r--r--docs/source/lang/api/digitalwrite.rst56
1 files changed, 0 insertions, 56 deletions
diff --git a/docs/source/lang/api/digitalwrite.rst b/docs/source/lang/api/digitalwrite.rst
deleted file mode 100644
index bae8db9..0000000
--- a/docs/source/lang/api/digitalwrite.rst
+++ /dev/null
@@ -1,56 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-digitalwrite:
-
-digitalWrite()
-==============
-
-Write a :ref:`HIGH <lang-constants-high>` or a :ref:`LOW
-<lang-constants-low>` value to a pin configured as :ref:`OUTPUT
-<lang-constants-output>`.
-
-Library Documentation
----------------------
-
-.. doxygenfunction:: digitalWrite
-
-Discussion
-----------
-
-If the pin has been configured as an ``OUTPUT`` with :ref:`pinMode()
-<lang-pinmode>` its voltage will be set to the corresponding value:
-3.3V for ``HIGH``, and 0V (ground) for ``LOW``.
-
-Because it is soldered to an LED and resistor in series, your board's
-:ref:`BOARD_LED_PIN <lang-board-values-led>` will respond slightly
-more slowly as an output than the other pins.
-
-Example
--------
-
-The following example sets the built-in LED pin to ``HIGH``, makes a
-one-second-long delay, sets the pin back to ``LOW``, and delays again,
-causing a blinking pattern (you could also use
-:ref:`lang-toggleled`)::
-
- void setup() {
- pinMode(BOARD_LED_PIN, OUTPUT); // sets the digital pin as output
- }
-
- void loop() {
- digitalWrite(BOARD_LED_PIN, HIGH); // sets the LED on
- delay(1000); // waits for a second
- digitalWrite(BOARD_LED_PIN, LOW); // sets the LED off
- delay(1000); // waits for a second
- }
-
-See Also
---------
-
-- :ref:`pinMode <lang-pinmode>`
-- :ref:`digitalRead <lang-digitalread>`
-- :ref:`BOARD_LED_PIN <lang-board-values-led>`
-- :ref:`lang-toggleled`
-- :ref:`lang-togglepin`
-
-.. include:: /arduino-cc-attribution.txt