From 3c8b23576fa81576bf72d5ef07ee32859f631c88 Mon Sep 17 00:00:00 2001
From: Chen Wang <unicorn_wang@outlook.com>
Date: Thu, 6 Mar 2025 11:00:09 +0800
Subject: 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>
---
 documentation/0.doxygen/example/src/function.c | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

(limited to 'documentation/0.doxygen/example/src/function.c')

diff --git a/documentation/0.doxygen/example/src/function.c b/documentation/0.doxygen/example/src/function.c
index 6ac5dc90de..289c09b2ce 100644
--- a/documentation/0.doxygen/example/src/function.c
+++ b/documentation/0.doxygen/example/src/function.c
@@ -43,17 +43,27 @@
  *
  * See
  * <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/src/function.c">documentation/0.doxygen/example/src/function.c</a>
- * for example.
+ * for code example.
  *
- * <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/src/function.h">documentation/0.doxygen/example/src/function.h</a> is an example of the header file where we just declare the API without doxygen documentation.
+ * See
+ * <a href="./group__group__doxygen__example__function.html">Doxygen Example of Function</a>
+ * for html output.
+ *
+ * @note <a href="https://github.com/RT-Thread/rt-thread/blob/master/documentation/0.doxygen/example/src/function.h">documentation/0.doxygen/example/src/function.h</a>
+ * is just an example of the header file where we declare the API without
+ * doxygen documentation.
  */
 
 /**
- * @addtogroup group_doxygen_example
+ * @defgroup group_doxygen_example_function Doxygen Example of Function
+ *
+ * @ingroup group_doxygen_example
+ *
+ * @brief Doxygen Example of Function.
+ *
+ * @{
  */
 
-/** @{ */
-
 /**
  * @brief Brief description for the function
  *
-- 
cgit v1.3.1