diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2012-06-29 19:14:42 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2012-06-29 19:14:42 -0400 |
| commit | 2c2d5715d56924c2e067434c285fddbfe78382b3 (patch) | |
| tree | 843f4087c7bec1e6ec7060d917a82c7062c70e02 /source/libmaple | |
| parent | f94bf279600d6a9e2358677facce29e76254e3ea (diff) | |
| download | librambutan-2c2d5715d56924c2e067434c285fddbfe78382b3.tar.gz librambutan-2c2d5715d56924c2e067434c285fddbfe78382b3.zip | |
Update <libmaple/util.h> page for Breathe fixes.
Breathe now supports macros with arguments, so use that.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'source/libmaple')
| -rw-r--r-- | source/libmaple/api/util.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/source/libmaple/api/util.rst b/source/libmaple/api/util.rst index 434307e..54377c0 100644 --- a/source/libmaple/api/util.rst +++ b/source/libmaple/api/util.rst @@ -16,17 +16,18 @@ Bit Manipulation The following macros are useful for bit manipulation. -**BIT(shift)**: ``1UL << (shift)`` - -**BIT_MASK_SHIFT(mask, shift)**: ``mask << shift`` - -**GET_BITS(x, m, n)**: Bits ``m`` to ``n`` of ``x``, right-aligned. - -**IS_POWER_OF_TWO(v)**: True iff ``v`` is a power of two (1, 2, 4, etc.) +.. doxygendefine:: BIT +.. doxygendefine:: BIT_MASK_SHIFT +.. doxygendefine:: GET_BITS +.. doxygendefine:: IS_POWER_OF_TWO Failure Routines ---------------- +``throb()`` is called by various routines to throb a built-in +LED. **Usually, you shouldn't call it yourself**; use something like +``ASSERT(0)`` (or the libc ``abort()`` function) instead. + .. doxygenfunction:: throb Asserts and Debug Levels |