rt-thread.git/documentation, branch v5.2.0

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

[doxygen] add doxygen comment for clk.c and clk.h (#9950)

2025-01-27T07:54:13Z

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>

doxygen: create framework to unify markdown and source code part (#9946)

2025-01-26T03:44:39Z

* 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 Co-authored-by: Supper Thomas <78900636@qq.com>

[doc]Update doxygen rtthread_logo.png (#9861)

2025-01-03T05:33:46Z

doc: introduce how to build & run doxygen on ubuntu

2024-12-23T04:09:02Z

Update readme doc to introduce how to build doxygen and run html on Ubuntu machines. Signed-off-by: Chen Wang

[documentation][Finsh]fix the wrong comments for FINSH_USING_SYMTAB macro in markdown files.

2024-11-27T03:17:17Z

[doxygen] add driver example for doxygen (#9446)

2024-09-15T00:22:44Z

[drivers] Specifies the name of the drivers driver file

2024-09-13T21:40:40Z

https://github.com/RT-Thread/rt-thread/pull/9420