summaryrefslogtreecommitdiff
path: root/documentation/0.doxygen/example/include/struct.h
diff options
context:
space:
mode:
authorChen Wang <[email protected]>2025-03-06 11:00:09 +0800
committerRbb666 <[email protected]>2025-03-06 11:46:21 +0800
commit3c8b23576fa81576bf72d5ef07ee32859f631c88 (patch)
treee0e0ae8b0c011fc87b0d175e8dc4347de70c3624 /documentation/0.doxygen/example/include/struct.h
parented8d0bc36b81b58d3842c434a33c2f958e97b2af (diff)
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 <[email protected]>
Diffstat (limited to 'documentation/0.doxygen/example/include/struct.h')
-rw-r--r--documentation/0.doxygen/example/include/struct.h16
1 files changed, 12 insertions, 4 deletions
diff --git a/documentation/0.doxygen/example/include/struct.h b/documentation/0.doxygen/example/include/struct.h
index 528e85487a..46f130319d 100644
--- a/documentation/0.doxygen/example/include/struct.h
+++ b/documentation/0.doxygen/example/include/struct.h
@@ -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
*