aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-02-09 21:10:34 -0500
committerMarti Bolivar <mbolivar@leaflabs.com>2011-02-09 21:10:34 -0500
commit2a0c7510fb91ba4a11b6772a8ae72685823907f8 (patch)
treed73f5ba8dc722032ab4f7efc913eecf2fd57dff4 /docs/source/lang/api
parent7366564129bf4e4030e9083f4521eda49d985fb8 (diff)
downloadlibrambutan-2a0c7510fb91ba4a11b6772a8ae72685823907f8.tar.gz
librambutan-2a0c7510fb91ba4a11b6772a8ae72685823907f8.zip
Fixed docs bug where we say "long" when we mean "long long"
Diffstat (limited to 'docs/source/lang/api')
-rw-r--r--docs/source/lang/api/constants.rst14
-rw-r--r--docs/source/lang/api/hardwaretimer.rst2
-rw-r--r--docs/source/lang/api/millis.rst2
-rw-r--r--docs/source/lang/api/random.rst8
4 files changed, 19 insertions, 7 deletions
diff --git a/docs/source/lang/api/constants.rst b/docs/source/lang/api/constants.rst
index 4426293..72738b8 100644
--- a/docs/source/lang/api/constants.rst
+++ b/docs/source/lang/api/constants.rst
@@ -242,10 +242,18 @@ type, follow it with:
For example, ``33U`` is an :ref:`unsigned int <lang-unsignedint>`.
- an ``l`` or ``L`` to interpret the constant as a long value. For
- example, ``100000L`` is a :ref:`long <lang-long>`.
+ example, ``100000L`` is a :ref:`long <lang-long>`. On the Maple,
+ ``long`` is just a synonym for ``int``.
- a ``ul`` or ``UL`` to do both. For example, ``32767UL`` is an
- :ref:`unsigned long <lang-unsignedlong>`.
+ :ref:`unsigned long <lang-unsignedlong>`. On the Maple, ``unsigned
+ long`` is just a synonym for ``unsigned int``.
+
+- an ``ll`` or ``LL`` to interpret the constant as a :ref:`long long
+ <lang-longlong>` value.
+
+- a ``ull`` or ``ULL`` to interpret the constant as an :ref:`unsigned
+ long long <lang-unsignedlonglong>`.
.. _lang-constants-fp:
@@ -321,6 +329,8 @@ See Also
- :ref:`unsigned int <lang-unsignedint>`
- :ref:`long <lang-long>`
- :ref:`unsigned long <lang-unsignedlong>`
+- :ref:`long long <lang-longlong>`
+- :ref:`unsigned long long <lang-unsignedlonglong>`
- :ref:`float <lang-float>`
- :ref:`double <lang-double>`
diff --git a/docs/source/lang/api/hardwaretimer.rst b/docs/source/lang/api/hardwaretimer.rst
index 258471b..3e5424c 100644
--- a/docs/source/lang/api/hardwaretimer.rst
+++ b/docs/source/lang/api/hardwaretimer.rst
@@ -317,6 +317,8 @@ For example, to set the prescale factor on timer 1 to 5, call
The :ref:`setPeriod() <lang-hardwaretimer-setperiod>` method may
also be used as a convenient alternative.
+.. _lang-hardwaretimer-resume:
+
.. cpp:function:: void HardwareTimer::resume()
Resume a paused timer, without affecting its configuration.
diff --git a/docs/source/lang/api/millis.rst b/docs/source/lang/api/millis.rst
index 54e4507..0288c56 100644
--- a/docs/source/lang/api/millis.rst
+++ b/docs/source/lang/api/millis.rst
@@ -40,7 +40,7 @@ Tip
Since the return value for ``millis()`` is an :ref:`unsigned long
<lang-unsignedlong>`, overflow errors may occur if you try to do math
-with other data types, such as :ref:`ints <lang-int>`.
+with other data types, such as :ref:`chars <lang-char>`.
See Also
--------
diff --git a/docs/source/lang/api/random.rst b/docs/source/lang/api/random.rst
index f2a9762..dd8871d 100644
--- a/docs/source/lang/api/random.rst
+++ b/docs/source/lang/api/random.rst
@@ -7,13 +7,13 @@ random()
The ``random()`` function generates pseudo-random numbers.
-.. TODO keep tracking Sphinx/Breathe's ability to reference overloaded
-.. functions so we can use doxygenfunction instead of manually
-.. documenting this.
-
Library Documentation
---------------------
+.. FIXME keep tracking Sphinx/Breathe's ability to reference
+.. overloaded functions so we can use doxygenfunction instead of
+.. manually documenting.
+
.. cpp:function:: random(long max)
Same as a call to ``random(0, max)``.