From 2a0c7510fb91ba4a11b6772a8ae72685823907f8 Mon Sep 17 00:00:00 2001 From: Marti Bolivar Date: Wed, 9 Feb 2011 21:10:34 -0500 Subject: Fixed docs bug where we say "long" when we mean "long long" --- docs/source/lang/api/constants.rst | 14 ++++++++++++-- docs/source/lang/api/hardwaretimer.rst | 2 ++ docs/source/lang/api/millis.rst | 2 +- docs/source/lang/api/random.rst | 8 ++++---- 4 files changed, 19 insertions(+), 7 deletions(-) (limited to 'docs/source/lang/api') 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 `. - an ``l`` or ``L`` to interpret the constant as a long value. For - example, ``100000L`` is a :ref:`long `. + example, ``100000L`` is a :ref:`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 `. + :ref:`unsigned long `. 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 + ` value. + +- a ``ull`` or ``ULL`` to interpret the constant as an :ref:`unsigned + long long `. .. _lang-constants-fp: @@ -321,6 +329,8 @@ See Also - :ref:`unsigned int ` - :ref:`long ` - :ref:`unsigned long ` +- :ref:`long long ` +- :ref:`unsigned long long ` - :ref:`float ` - :ref:`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() ` 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 `, overflow errors may occur if you try to do math -with other data types, such as :ref:`ints `. +with other data types, such as :ref:`chars `. 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)``. -- cgit v1.2.3