diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-02-09 21:10:34 -0500 | 
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2011-02-09 21:10:34 -0500 | 
| commit | 9768ee6b2f60442676613c154ad784b30191711c (patch) | |
| tree | bef1b50fde1ea3eafc89124b31dae82979ca8d14 /source/lang/api | |
| parent | 9ea60c7e7dffd06791ec2dc62ffab3f2bf802f08 (diff) | |
| download | librambutan-9768ee6b2f60442676613c154ad784b30191711c.tar.gz librambutan-9768ee6b2f60442676613c154ad784b30191711c.zip | |
Fixed docs bug where we say "long" when we mean "long long"
Diffstat (limited to 'source/lang/api')
| -rw-r--r-- | source/lang/api/constants.rst | 14 | ||||
| -rw-r--r-- | source/lang/api/hardwaretimer.rst | 2 | ||||
| -rw-r--r-- | source/lang/api/millis.rst | 2 | ||||
| -rw-r--r-- | source/lang/api/random.rst | 8 | 
4 files changed, 19 insertions, 7 deletions
| diff --git a/source/lang/api/constants.rst b/source/lang/api/constants.rst index 4426293..72738b8 100644 --- a/source/lang/api/constants.rst +++ b/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/source/lang/api/hardwaretimer.rst b/source/lang/api/hardwaretimer.rst index 258471b..3e5424c 100644 --- a/source/lang/api/hardwaretimer.rst +++ b/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/source/lang/api/millis.rst b/source/lang/api/millis.rst index 54e4507..0288c56 100644 --- a/source/lang/api/millis.rst +++ b/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/source/lang/api/random.rst b/source/lang/api/random.rst index f2a9762..dd8871d 100644 --- a/source/lang/api/random.rst +++ b/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)``. | 
