rt-thread.git/documentation/0.doxygen/example/include/struct.h, branch copilot/update-elm-fatfs-to-r016Unnamed repository; edit this file 'description' to name the repository.http://cgit.235523.xyz/rt-thread.git/atom/documentation/0.doxygen/example/include/struct.h?h=copilot%2Fupdate-elm-fatfs-to-r0162025-03-10T02:08:48Zdoxygen: improve howto2025-03-10T02:08:48ZChen Wangunicorn_wang@outlook.com2025-03-06T07:52:37Zurn:sha1:94afe6a4f17af4669cb843d1ee6f847fbc53c56e
- 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>
doxygen: group examples in subpages2025-03-06T03:46:21ZChen Wangunicorn_wang@outlook.com2025-03-06T03:00:09Zurn:sha1:3c8b23576fa81576bf72d5ef07ee32859f631c88
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>
doxygen: add documentation for doxygen2025-02-11T09:09:44ZChen Wangunicorn_wang@outlook.com2025-02-06T06:31:06Zurn:sha1:761bb89f27d7e2569fce48b06faf5825fa645f17
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>