aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/delay.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/delay.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/delay.rst')
-rw-r--r--docs/source/lang/api/delay.rst69
1 files changed, 0 insertions, 69 deletions
diff --git a/docs/source/lang/api/delay.rst b/docs/source/lang/api/delay.rst
deleted file mode 100644
index 30bd436..0000000
--- a/docs/source/lang/api/delay.rst
+++ /dev/null
@@ -1,69 +0,0 @@
-.. highlight:: cpp
-
-.. _lang-delay:
-
-delay()
-=======
-
-Pauses the program for at least a given number of milliseconds. (There
-are 1000 milliseconds in a second.)
-
-Library Documentation
----------------------
-
-.. doxygenfunction:: delay
-
-
-Discussion
-----------
-
-While it is easy to create a blinking LED with the ``delay()``
-function, and many sketches use short delays for such tasks as switch
-debouncing, the use of ``delay()`` in a sketch has significant
-drawbacks. No other reading of sensors, mathematical calculations, or
-pin manipulation can go on during the delay function, so in effect, it
-brings most other activity to a halt. For alternative approaches to
-controlling timing see the :ref:`millis() <lang-millis>` function
-and the "Blink Without Delay" sketch cited :ref:`below
-<lang-delay-seealso>`\ . More knowledgeable programmers usually
-avoid the use of ``delay()`` for timing of events longer than tens of
-milliseconds, unless the sketch is very simple.
-
-Certain things *do* go on while the ``delay()`` function is
-controlling the STM32 chip, however, because the delay function does
-not disable interrupts. Serial communication that appears at the RX
-pin is recorded, PWM (see :ref:`pwmWrite() <lang-pwmwrite>`\ ) values
-and pin states are maintained, and :ref:`interrupts
-<lang-attachinterrupt>` will work as they should.
-
-
-Example
--------
-
-::
-
- void setup() {
- // set up the built-in LED pin for output:
- pinMode(BOARD_LED_PIN, 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
- }
-
-.. _lang-delay-seealso:
-
-See Also
---------
-
-- :ref:`millis() <lang-millis>`
-- :ref:`micros() <lang-micros>`
-- :ref:`delayMicroseconds() <lang-delayMicroseconds>`
-- (Arduino) `Blink Without Delay
- <http://arduino.cc/en/Tutorial/BlinkWithoutDelay>`_ example (works
- unmodified on Maple)
-
-.. include:: /arduino-cc-attribution.txt