summaryrefslogtreecommitdiff
path: root/documentation/0.doxygen/example/include/struct.h
AgeCommit message (Collapse)Author
2025-03-10doxygen: improve howtoChen Wang
- 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 <[email protected]>
2025-03-06doxygen: group examples in subpagesChen Wang
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]>
2025-02-11doxygen: add documentation for doxygenChen Wang
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 <[email protected]>