RT-Thread/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-10-19 03:13:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

doxygen: group examples in subpages

Browse Source 
Doxygen examples are grouped on different pages so that you can
easily link to pages of related types in the documentation.
For example, macro examples have their own page, and function
examples have their own page, which correspond to their own code
examples, such as "macro.h" or "function.h".

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang
2025-03-06 11:00:09 +08:00
committed by Rbb666
parent ed8d0bc36b
commit 3c8b23576f
7 changed files with 84 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
documentation/0.doxygen/example/include/macro.h
View File

@@ -10,7 +10,7 @@
* recommend putting documentation after members. See `DOXYGEN_EXAMPLE_CONST_A`
* and `DOXYGEN_EXAMPLE_CONST_B` 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 exmaple.
* for code exmaple.
*
* - The other is to define macros with parameters. For this type of
* macro, we recommend using a method similar to documenting for
@@ -18,15 +18,23 @@
* More details please see @ref page_howto_function
* See `DOXYGEN_EXAMPLE_ABS` 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 example.
* for code example.
*
* See
* <a href="./group__group__doxygen__example__macro.html">Doxygen Example of Macro</a>
* for html output.
*/
/**
* @addtogroup group_doxygen_example
/**
* @defgroup group_doxygen_example_macro Doxygen Example of Macro
*
* @ingroup group_doxygen_example
*
* @brief Doxygen Example of Macro.
*
* @{
*/
/** @{ */
#define DOXYGEN_EXAMPLE_CONST_A 100 /**< Description of macro const A */
#define DOXYGEN_EXAMPLE_CONST_B 200 /**< Description of macro const B */