aboutsummaryrefslogtreecommitdiffstats
path: root/source/lang/api
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-05-20 15:30:15 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-05-23 10:18:39 -0400
commit9975593eb413c7bdb5711f25d9cedb6c276cfd65 (patch)
tree285b6304a358581b8ed786935447ceaa6d61113e /source/lang/api
parentfce940294469a49a4d04302a790e9e399e81ad06 (diff)
downloadlibrambutan-9975593eb413c7bdb5711f25d9cedb6c276cfd65.tar.gz
librambutan-9975593eb413c7bdb5711f25d9cedb6c276cfd65.zip
0.0.10 docs RC
Diffstat (limited to 'source/lang/api')
-rw-r--r--source/lang/api/board-values.rst13
-rw-r--r--source/lang/api/constants.rst1
-rw-r--r--source/lang/api/hardwarespi.rst2
-rw-r--r--source/lang/api/serial.rst2
4 files changed, 10 insertions, 8 deletions
diff --git a/source/lang/api/board-values.rst b/source/lang/api/board-values.rst
index 5fbf20f..7198407 100644
--- a/source/lang/api/board-values.rst
+++ b/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/source/lang/api/constants.rst b/source/lang/api/constants.rst
index 00c1a5c..3ba99f0 100644
--- a/source/lang/api/constants.rst
+++ b/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/source/lang/api/hardwarespi.rst b/source/lang/api/hardwarespi.rst
index 289ded5..a80e429 100644
--- a/source/lang/api/hardwarespi.rst
+++ b/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/source/lang/api/serial.rst b/source/lang/api/serial.rst
index 0821f43..a08c9b7 100644
--- a/source/lang/api/serial.rst
+++ b/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