diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-05 16:17:16 -0400 | 
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2011-05-05 16:17:16 -0400 | 
| commit | 7904a5921a75ee4f99fb2662d7b540b56d6a7cb3 (patch) | |
| tree | 807a4794005807f50eb35ec3da1dccf653b8d44a /docs | |
| parent | ef8c58b96ea8d1e503362c5d18a74cd5d0101e0c (diff) | |
| download | librambutan-7904a5921a75ee4f99fb2662d7b540b56d6a7cb3.tar.gz librambutan-7904a5921a75ee4f99fb2662d7b540b56d6a7cb3.zip  | |
Documentation link fixes.
Fixing some Sphinx error messages.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/hardware/maple.rst | 2 | ||||
| -rw-r--r-- | docs/source/lang/cpp/built-in-types.rst | 31 | ||||
| -rw-r--r-- | docs/source/libraries.rst | 2 | ||||
| -rw-r--r-- | docs/source/pwm.rst | 2 | ||||
| -rw-r--r-- | docs/source/troubleshooting.rst | 6 | 
5 files changed, 25 insertions, 18 deletions
diff --git a/docs/source/hardware/maple.rst b/docs/source/hardware/maple.rst index 44848a7..f4fcaf4 100644 --- a/docs/source/hardware/maple.rst +++ b/docs/source/hardware/maple.rst @@ -313,6 +313,8 @@ Rev 3  * **Pin 3 AIN missing**: Pin 3 is capable of analog input, but the    corresponding "AIN" is missing from the Rev 3 silkscreen. +.. _maple-rev3-bad-buttons: +  * **Bad/Sticky Buttons**: a number of Rev 3 boards sold in May-June 2010    have questionable RESET and BUT buttons. diff --git a/docs/source/lang/cpp/built-in-types.rst b/docs/source/lang/cpp/built-in-types.rst index a7349e6..28e8cdc 100644 --- a/docs/source/lang/cpp/built-in-types.rst +++ b/docs/source/lang/cpp/built-in-types.rst @@ -41,55 +41,60 @@ Integral types  .. cpp:type:: int8 -   Synonym for ``char``. +   8-bit integer value.  Synonym for ``signed char``.  .. cpp:type:: uint8 -   Synonym for ``unsigned char``. +   8-bit unsigned integer value.  Synonym for ``unsigned char``. + +.. cpp:type:: byte + +   8-bit unsigned integer value.  Synonym for ``unsigned char``.  .. cpp:type:: int16 -   Synonym for ``short``. +   16-bit integer value.  Synonym for ``short``.  .. cpp:type:: uint16 -   Synonym for ``unsigned short``. +   16-bit unsigned integer value.  Synonym for ``unsigned short``.  .. cpp:type:: int32 -   Synonym for ``int``. +   32-bit integer value.  Synonym for ``int``.  .. cpp:type:: uint32 -   Synonym for ``unsigned int`` +   Unsigned 32-bit integer value.  Synonym for ``unsigned int``  .. cpp:type:: int64 -   Synonym for ``long long`` +   64-bit integer value.  Synonym for ``long long``  .. cpp:type:: uint64 -   Synonym for ``unsigned long long``. +   Unsigned 64-bit integer value.  Synonym for ``unsigned long long``.  Floating-Point Types  --------------------  .. cpp:type:: float -   32-bit, IEEE 754 single-precision floating-point type. +   32-bit, IEEE-754 single-precision floating-point type.  .. cpp:type:: double -   64-bit, IEEE 754 double-precision floating-point type. +   64-bit, IEEE-754 double-precision floating-point type.  Other Types  -----------  .. cpp:type:: voidFuncPtr -   Pointer to a function that takes no arguments and returns nothing, i.e. - -   :: +   Pointer to a function that takes no arguments and returns nothing, i.e. ::         typedef void (*voidFuncPtr)(void); +.. cpp:type:: bool + +   Boolean type. diff --git a/docs/source/libraries.rst b/docs/source/libraries.rst index 2bc8b11..44a72f7 100644 --- a/docs/source/libraries.rst +++ b/docs/source/libraries.rst @@ -40,7 +40,7 @@ library are noted in the library's documentation.       (``malloc()``, etc.) is not available.     - If you're looking for low-level hardware support libraries, see -     the :ref:`libmaple Reference`. +     the :ref:`libmaple Reference <libmaple>`.  .. _libraries-servo: diff --git a/docs/source/pwm.rst b/docs/source/pwm.rst index ac67689..34ad508 100644 --- a/docs/source/pwm.rst +++ b/docs/source/pwm.rst @@ -25,7 +25,7 @@ Each PWM output is driven by an output channel connected to one of 4  timers.  Some configuration, such as the clock rate or prescaling,  must be common to the entire timer; see the :ref:`timer documentation  <timers>` for more information.  See your board's :ref:`pin mapping -tables <gpio-pin-mapping-tables>` to track down the correspondence +tables <gpio-pin-maps>` to track down the correspondence  between timer channels and GPIO pins.  Background diff --git a/docs/source/troubleshooting.rst b/docs/source/troubleshooting.rst index f49580c..bf1b129 100644 --- a/docs/source/troubleshooting.rst +++ b/docs/source/troubleshooting.rst @@ -48,9 +48,9 @@ The reset and D38/serial buttons don't seem to work reliably!  -------------------------------------------------------------  A few Maple Rev3 boards shipped in May-June 2010 may have had -unreliable buttons; see the :ref:`errata page <maple-errata>` for -details.  `We're happy to replace these for you -<http://leaflabs.com/contact>`_\ ! +unreliable buttons; see the :ref:`Maple Errata +<maple-rev3-bad-buttons>` for details.  `We're happy to replace these +for you <http://leaflabs.com/contact>`_\ !  .. _troubleshooting-ide-install:  | 
