12 Commits

Author	SHA1	Message	Date
Chen Wang	afb3f22973	doxygen: fixed duplicated comments for cpu APIs ... Refer to the issue described in PR #10599. This was a temporary fix at that time. After further research, we discovered that this issue can be addressed using the "@cond" command supported by Doxygen. Since we currently do not intend to generate two sets of documentation for UP and MP when generating Doxygen documentation, the current solution is to generate only MP documentation by default. For functions defined in MP but not in UP, we will use the "@note" command in the function's Doxygen comment to indicate whether the function supports both UP and MP, or only MP. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-09-08 22:20:52 +08:00
Chen Wang	c050c8e642	doxygen: use layout to control the html display ... Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-06-18 08:45:40 +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
wumingzi	fb64052722	[RFC][doxygen]Doxygen comment standard processing (#10058) ... Signed-off-by: 1078249029 <1078249029@qq.com>	2025-03-01 16:02:17 +08:00
Chen Wang	75722c4998	doxygen: reorganize directory structure ... The original directory structure was too flat and inconvenient to view. The directory is now reorganized according to the first-level chapters, and some sub-chapters are moved to the second-level directory. Note: documentation/env is not moved to documentation/4.tool because there are too many external places that reference this path, especially in bsp, so this directory path remains as it is. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-25 11:27:58 +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
wumingzi	6481633ec6	[doxygen] add doxygen comment for clk.c and clk.h (#9950) ... Accroding to #9947 and #9424, adding doxygen comment for function in .c files and data structure, macro in .h file is a solution.For this pr, I encountered problem following situations. - rt_clk_unprepare function return value type is different from rt_clk_ops so I change type of rt_clk_unprepare and its dependencies. - clk_get function may be similar as rt_clk_unprepare but I'm not sure so not modify. - clk_release implements may be incomplete, so I just marked in comment. Signed-off-by: 1078249029 <1078249029@qq.com>	2025-01-27 15:54:13 +08:00
Chen Wang	40f3b6a569	doxygen: create framework to unify markdown and source code part (#9946) ... * doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com>	2025-01-26 11:44:39 +08:00
Meco Man	5af97a1f7f	move documentation repo to rt-thread repo	2022-03-12 00:56:03 -05:00
yiyue.fang	da597730d1	change the version number in doxyfile ... 1.1.0 -> 1.2.0	2013-04-10 21:51:00 +08:00
bernard.xiong	10770dfe0d	Add doxygen image. ... git-svn-id: https://rt-thread.googlecode.com/svn/trunk@2319 bbd45198-f89e-11dd-88c7-29a3b14d5316	2012-10-05 23:27:28 +00:00
bernard.xiong@gmail.com	5064df210f	Add doxygen script files. ... git-svn-id: https://rt-thread.googlecode.com/svn/trunk@2312 bbd45198-f89e-11dd-88c7-29a3b14d5316	2012-09-29 05:51:41 +00:00