rt-thread.git/documentation/0.doxygen, branch v5.2.1

doxygen: change group_Device to group_device_driver

2025-05-30T06:06:29Z

The originally defined "group_Device" should actually be part of the device-driver component, so create a new "group_device_driver" and then rename "group_Device" to "group_device_driver". Signed-off-by: Chen Wang

doxygen: re-org module groups (#10197)

2025-04-18T02:44:43Z

Match the organization of modules (groups) with that of user guide. Preliminary arrangement. This patch is just a framework arrangement. Details need to be continued. P.S., in this patch, adding numerical prefixes to the files in documentation/0.doxygen is to meet the need of displaying sorting in HTML pages. Signed-off-by: Chen Wang

doxygen: cleanup and re-org files

2025-04-13T07:28:21Z

This patch contains two small changes, mainly to prepare for the next step of organizing the modules framework. The first change: move the files related to doxygen examples to `documentation/0.doxygen/example/` The second change: delete `documentation/0.doxygen/mainpage.h`, which is the mainpage of the old page. Now the new mainpage is `documentation/INDEX.md`, so the duplicate can be deleted. Signed-off-by: Chen Wang

doxygen: fix wrong ref for group examples

2025-03-12T04:55:06Z

Fixes: 94afe6a4f1 ("doxygen: improve howto") Signed-off-by: Chen Wang

doxygen: improve howto

2025-03-10T02:08:48Z

- 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

doxygen: group examples in subpages

2025-03-06T03:46:21Z

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

Add recommanded script and extension for writing doxygen comments on … (#10001)

2025-02-19T01:06:15Z

Add recommanded script and extension for writing doxygen comments on vscode Signed-off-by: 1078249029 <1078249029@qq.com>

doxygen: add prefix for groups (#9991)

2025-02-15T04:15:19Z

* doxygen: add prefix for groups Add "group_" prefix to doxygen group names. This makes it easier to grep with group name later. This patch only modifies the groups defined in the pathes of INPUT of documentation/Doxyfile: INPUT = . \ ../src \ ../include \ ../components/finsh \ ../components/drivers/include/drivers \ ../components/drivers/clk \ ../components/dfs/dfs_v2/src \ ../components/dfs/dfs_v2/include Other groups are not touched. Signed-off-by: Chen Wang * ci: fixed error report when run file_check.py Such as: - "please delete extra space at the end of this line." - "the RT-Thread error code should return negative value. e.g. return -RT_ERROR" Signed-off-by: Chen Wang --------- Signed-off-by: Chen Wang

doxygen: add prefix for page name (#9989)

2025-02-13T15:28:19Z

Add prefix "page_" to the name of pages. Add this as a rule in guide of writing doxygen documents. Signed-off-by: Chen Wang

doxygen: add documentation for doxygen

2025-02-11T09:09:44Z

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