Skip to content

Commit 052f01e

Browse files
committed
Improve macro and comments documentation.
1 parent a41710a commit 052f01e

File tree

3 files changed

+42
-12
lines changed

3 files changed

+42
-12
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ and this project adheres to [0-based versioning](https://0ver.org/).
1010
### Changed
1111

1212
- Improve macro comments in `libs/common/macros.h`.
13+
- Improve macro and comments documentation.
1314

1415
## v0.14.1 - 30-August-2025
1516

Doxyfile.in

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,18 @@ WARN_AS_ERROR = YES
1212

1313
MACRO_EXPANSION = YES
1414
PREDEFINED = "AM_PRINTF(a,b)=" \
15-
"AM_MAY_ALIAS="
15+
"AM_MAY_ALIAS=" \
16+
"AM_ASSERT_STATIC(x)="
1617

1718
EXCLUDE_PATTERNS = *test*,\
1819
*stubs*,\
1920
*cobszpe*,\
2021
*freertos*
2122

22-
EXCLUDE_SYMBOLS = AM_ASSERT_STATIC \
23-
AM_POOL_BLOCK_SIZEOF \
23+
EXCLUDE_SYMBOLS = AM_POOL_BLOCK_SIZEOF \
2424
AM_POOL_BLOCK_ALIGNMENT \
2525
_POSIX_C_SOURCE \
2626
_GNU_SOURCE \
27-
AM_EVT_RANGE_HSM_BEGIN \
28-
AM_EVT_RANGE_HSM_END \
29-
AM_EVT_RANGE_FSM_BEGIN \
30-
AM_EVT_RANGE_FSM_END \
31-
AM_EVT_INTERNAL_MAX \
3227
AM_EVENT_REF_COUNTER_BITS \
3328
AM_EVENT_REF_COUNTER_MASK \
3429
AM_EVENT_TICK_DOMAIN_BITS \

docs/api.rst

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,46 @@ API
55

66
This part of the documentation covers all the Amast interfaces.
77

8-
.. _common_constants:
8+
.. _common_macros_and_constants:
99

10-
Common Constants
11-
----------------
10+
Common Macros And Constants
11+
---------------------------
1212

13-
.. doxygenfile:: alignment.h
13+
.. doxygendefine:: AM_ALIGNOF
14+
15+
.. doxygendefine:: AM_ALIGNOF_DEFINE
16+
17+
.. doxygendefine:: AM_ALIGNOF_PTR
18+
19+
.. doxygendefine:: AM_ALIGN_MAX
20+
21+
.. doxygendefine:: AM_ALIGN_PTR_DOWN
22+
23+
.. doxygendefine:: AM_ALIGN_PTR_UP
24+
25+
.. doxygendefine:: AM_ALIGN_SIZE
26+
27+
.. doxygendefine:: AM_ASSERT
28+
29+
.. doxygendefine:: AM_ASSERT_STATIC
30+
31+
.. doxygendefine:: AM_CAST
32+
33+
.. doxygendefine:: AM_COUNTOF
34+
35+
.. doxygendefine:: AM_CONTAINER_OF
36+
37+
.. doxygendefine:: AM_DO_EVERY
38+
39+
.. doxygendefine:: AM_DO_ONCE
40+
41+
.. doxygendefine:: AM_DO_EACH_MS
42+
43+
.. doxygendefine:: AM_MAX
44+
45+
.. doxygendefine:: AM_MIN
46+
47+
.. doxygendefine:: AM_VCAST
1448

1549
.. _common_types:
1650

0 commit comments

Comments
 (0)