Imagelibrary/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-12-07 16:12:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

doxygen: improve howto

Browse Source 
- 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>
This commit is contained in:
Chen Wang
2025-03-06 15:52:37 +08:00
committed by Rbb666
parent b506228893
commit 94afe6a4f1
7 changed files with 82 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
documentation/0.doxygen/example/include/groups.h
View File

@@ -26,9 +26,7 @@
* <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 code example.
*
* See
* <a href="./group__group__doxygen__example__sub.html">Doxygen Example of Groups and Sub-Groups</a>
* for html output.
* See @ref group_doxygen_example for html output.
*
* More information can be found in the Doxygen manual:
* <a href="https://www.doxygen.nl/manual/grouping.html">Grouping</a>.