RT-Thread/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-10-17 08:03:45 +08:00
Code Issues Packages Projects Releases Wiki Activity
16,953 Commits 15 Branches 42 Tags
94afe6a4f17af4669cb843d1ee6f847fbc53c56e
Commit Graph

3 Commits

Author SHA1 Message Date
Chen Wang
94afe6a4f1 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>
 2025-03-10 10:08:48 +08:00
Chen Wang
3c8b23576f 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>
 2025-03-06 11:46:21 +08:00
Chen Wang
761bb89f27 doxygen: add documentation for doxygen 
Documentation is provided to clarify how to write
doxygen documentation for RT-Thread. This document
is also integrated as part of RT-Thread doxygen
documentation.

An example is also provided.

The original README.md is removed and integrated into
this document.

Updated github actions for doxygen too.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
 2025-02-11 17:09:44 +08:00