diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-20 15:30:15 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-23 10:18:39 -0400 |
| commit | 38281ff738bc9a561085f39c427ce3f5b6f0d791 (patch) | |
| tree | 7c9dae7b52a9ad1b3d0d571c44a839af8d411222 /docs/source/lang/api | |
| parent | be9f630cf2ef27d3fa61ded6e23c69f3a30ba0ad (diff) | |
| download | librambutan-38281ff738bc9a561085f39c427ce3f5b6f0d791.tar.gz librambutan-38281ff738bc9a561085f39c427ce3f5b6f0d791.zip | |
0.0.10 docs RC
Diffstat (limited to 'docs/source/lang/api')
| -rw-r--r-- | docs/source/lang/api/board-values.rst | 13 | ||||
| -rw-r--r-- | docs/source/lang/api/constants.rst | 1 | ||||
| -rw-r--r-- | docs/source/lang/api/hardwarespi.rst | 2 | ||||
| -rw-r--r-- | docs/source/lang/api/serial.rst | 2 |
4 files changed, 10 insertions, 8 deletions
diff --git a/docs/source/lang/api/board-values.rst b/docs/source/lang/api/board-values.rst index 5fbf20f..7198407 100644 --- a/docs/source/lang/api/board-values.rst +++ b/docs/source/lang/api/board-values.rst @@ -23,9 +23,6 @@ Documentation <index-boards>`. Constants --------- -.. TODO [systick.rst] Add a link to systick.rst instead of systick.h -.. below, when systick.rst exists. - - ``CYCLES_PER_MICROSECOND``: Number of CPU cycles per microsecond on your board. @@ -35,9 +32,8 @@ Constants - ``CLOCK_SPEED_HZ``: Clock speed of your board, in hertz (Hz). This is the same as ``CLOCK_SPEED_MHZ`` × 1,000,000. -- ``SYSTICK_RELOAD_VAL``: Value used when reloading the :ref:`SysTick - <libmaple-systick>` timer's counter. For :ref:`lang-millis` to work - properly, this must be ``CYCLES_PER_MICROSECOND`` × 1,000 - 1. +- ``SYSTICK_RELOAD_VAL``: Value used when reloading the :ref:`systick` + timer's counter [#fmillis]_. .. _lang-board-values-but: @@ -205,3 +201,8 @@ See Also - :ref:`lang-pwmwrite` - :ref:`lang-enabledebugports` - :ref:`lang-disabledebugports` + +.. rubric:: Footnotes + +.. [#fmillis] In order for :ref:`lang-millis` to work properly, this + must be ``CYCLES_PER_MICROSECOND`` × 1,000 - 1. diff --git a/docs/source/lang/api/constants.rst b/docs/source/lang/api/constants.rst index 00c1a5c..3ba99f0 100644 --- a/docs/source/lang/api/constants.rst +++ b/docs/source/lang/api/constants.rst @@ -42,6 +42,7 @@ Note that the ``true`` and ``false`` constants are typed in lowercase; unlike e.g. ``HIGH``, ``LOW``, ``INPUT``, and ``OUTPUT`` (which are described below). +.. _lang-pin-levels: Pin Levels: HIGH and LOW ------------------------ diff --git a/docs/source/lang/api/hardwarespi.rst b/docs/source/lang/api/hardwarespi.rst index 289ded5..a80e429 100644 --- a/docs/source/lang/api/hardwarespi.rst +++ b/docs/source/lang/api/hardwarespi.rst @@ -43,7 +43,7 @@ Turning the SPI Port On Now it's time to turn your SPI port on. Do this with the ``begin()`` function (an example is given below). -.. FIXME [0.0.10] Breathe doesn't include the class; fix & submit pull req +.. FIXME [0.0.11] Breathe doesn't include the class; fix & submit pull req .. doxygenfunction:: HardwareSPI::begin diff --git a/docs/source/lang/api/serial.rst b/docs/source/lang/api/serial.rst index 0821f43..a08c9b7 100644 --- a/docs/source/lang/api/serial.rst +++ b/docs/source/lang/api/serial.rst @@ -12,7 +12,7 @@ devices. Introduction ------------ -.. FIXME [0.0.10] UART4, UART5 +.. FIXME [0.0.12/Maple Native] UART4, UART5 To use a serial port to communicate with an external serial device, connect the TX pin to your device's RX pin, the RX to your device's TX |