7 Commits

Include renames

Author	SHA1	Message	Date
Chen Wang	273185b45a	doxygen: fix two issues when building with doxygen 1.9.8 (#10768) ... * doxygen: remove @return command if function return void When doxygen is upgraded to v1.9.8 (on ubuntu 24.04), doxygen reports: "doxygen error: found documented return type for xxx that does not return anything" for those functions which return void but declare "@return" in doxygen comment. Solution: remove "@return" for those cases, and update guide document for how to write doxgen comment for functions. Signed-off-by: Chen Wang <unicorn_wang@outlook.com> * doxygen: fixed a minor typo for uart doc This error is found when building with doxygen 1.9.8, but not detecetd on 1.9.1. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-10-10 10:05:06 +08:00
Chen Wang	55428e4393	doxygen: re-org module groups (#10197) ... 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 <unicorn_wang@outlook.com>	2025-04-18 10:44:43 +08:00
Chen Wang	4ff1cfce64	doxygen: cleanup and re-org files ... 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 <unicorn_wang@outlook.com>	2025-04-13 15:28:21 +08:00
Chen Wang	88607c1404	doxygen: fix wrong ref for group examples ... Fixes: 94afe6a4f1 ("doxygen: improve howto") Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-03-12 12:55:06 +08:00
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