doxygen: improve howto

- Add description on how to group macros.
- Add description for structs on how to write comments
  for members when the name of member is too.
- Use @ref to link group instead of the html filenames.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang
2025-03-06 15:52:37 +08:00
committed by Rbb666
parent b506228893
commit 94afe6a4f1
7 changed files with 82 additions and 32 deletions

View File

@@ -20,9 +20,14 @@
* <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/include/macro.h">documentation/0.doxygen/example/include/macro.h</a>
* for code example.
*
* See
* <a href="./group__group__doxygen__example__macro.html">Doxygen Example of Macro</a>
* for html output.
* We often categorize macros in our code. Similarly, when writing doxygen
* comments for these categorized macros, we can also group them. See
* `DOXYGEN_EXAMPLE_GROUP_A_X`/`DOXYGEN_EXAMPLE_GROUP_A_Y` and
* `DOXYGEN_EXAMPLE_GROUP_B_X`/`DOXYGEN_EXAMPLE_GROUP_B_Y` in
* <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/include/macro.h">documentation/0.doxygen/example/include/macro.h</a>
* for code example.
*
* See @ref group_doxygen_example_macro for html output.
*/
/**
@@ -47,6 +52,28 @@
*/
#define DOXYGEN_EXAMPLE_ABS(x) (((x)>0)?(x):-(x))
/**
* @defgroup group_doxygen_example_macro_group_a Group A of Macros
*
* @brief Doxygen Example of Macros grouped in A.
*
* @{
*/
#define DOXYGEN_EXAMPLE_GROUP_A_X 0x0000 /**< Description of X in group A */
#define DOXYGEN_EXAMPLE_GROUP_A_Y 0x0001 /**< Description of Y in group A */
/** @} */
/**
* @defgroup group_doxygen_example_macro_group_b Group B of Macros
*
* @brief Doxygen Example of Macros grouped in B
*
* @{
*/
#define DOXYGEN_EXAMPLE_GROUP_B_X 0x0000 /**< Description of X in group B */
#define DOXYGEN_EXAMPLE_GROUP_B_Y 0x0001 /**< Description of Y in group B */
/** @} */
/** @} */
#endif