RT-Thread/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-10-19 12:14:30 +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

16
documentation/0.doxygen/example/include/struct.h
View File

@@ -18,15 +18,23 @@
*
* See
* <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/include/struct.h">documentation/0.doxygen/example/include/struct.h</a>
* for example.
* for code example.
*
* See
* <a href="./group__group__doxygen__example__struct.html">Doxygen Example of Structure</a>
* for html output.
*/
/**
* @addtogroup group_doxygen_example
* @defgroup group_doxygen_example_struct Doxygen Example of Structure
*
* @ingroup group_doxygen_example
*
* @brief Doxygen Example of Structure.
*
* @{
*/
/** @{ */
/**
* @brief Brief description this structure
*