mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-10-19 20:43:43 +08:00
doxygen: group examples in subpages
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:
@@ -24,14 +24,18 @@
|
||||
*
|
||||
* See
|
||||
* <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/include/groups.h">documentation/0.doxygen/example/include/groups.h</a>
|
||||
* for example.
|
||||
* for code example.
|
||||
*
|
||||
* See
|
||||
* <a href="./group__group__doxygen__example__sub.html">Doxygen Example of Groups and Sub-Groups</a>
|
||||
* for html output.
|
||||
*
|
||||
* More information can be found in the Doxygen manual:
|
||||
* <a href="https://www.doxygen.nl/manual/grouping.html">Grouping</a>.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup group_doxygen_example_sub Sub Group of Doxygen Example
|
||||
* @defgroup group_doxygen_example_sub Doxygen Example of Groups
|
||||
*
|
||||
* All members of this group will be displayed in one HTML page.
|
||||
*
|
||||
|
Reference in New Issue
Block a user