From 94afe6a4f17af4669cb843d1ee6f847fbc53c56e Mon Sep 17 00:00:00 2001
From: Chen Wang <unicorn_wang@outlook.com>
Date: Thu, 6 Mar 2025 15:52:37 +0800
Subject: doxygen: improve howto

- Add description on how to group macros.
- Add description for structs on how to write comments
  for members when the name of member is too.
- Use @ref to link group instead of the html filenames.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
---
 documentation/0.doxygen/example/src/function.c | 4 +---
 1 file changed, 1 insertion(+), 3 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 289c09b2ce..98b2007dea 100644
--- a/documentation/0.doxygen/example/src/function.c
+++ b/documentation/0.doxygen/example/src/function.c
@@ -45,9 +45,7 @@
  * <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 code example.
  *
- * See
- * <a href="./group__group__doxygen__example__function.html">Doxygen Example of Function</a>
- * for html output.
+ * See @ref group_doxygen_example_function 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
-- 
cgit v1.3.1