rt-thread.git/.github/workflows/doxygen.yml, branch master

doxygen: support 1.9.8

2025-10-10T12:19:05Z

The current test environment is mainly based on Ubuntu 22.04 LTS and doxygen version is 1.9.1. But when we switch to Ubuntu 24.04, the default Doxygen version on Ubuntu 24.04 is 1.9.8. The supported configuration and layout file formats differ from those in 1.9.1 (Ubuntu 22.04). In particular, the layout XML file format of 1.9.8 is incompatible with the older format(1.9.1). Therefore, to support Doxygen on Ubuntu 24.04, we need to load different configuration and layout files. (The layout file is specified using the LAYOUT_FILE parameter in the configuration file.) Solution: Provide corresponding configuration and layout files for different Doxygen versions, distinguished by the Doxygen version number. Currently, only Doxygen versions 1.9.1 and above are supported. If the doxygen version is >= 1.9.1 but < 1.9.8, the 1.9.1 configuration and layout are used by default. If the doxygen version is >= 1.9.8, the 1.9.8 configuration and layout are used. Only 1.9.1 and 1.9.8 have been tested, as these are the default doxygen versions on Ubuntu 22.04 LTS and Ubuntu 24.04. Other versions have not been tested yet. If necessary, we will change the configuration based on the same approach in the future. Signed-off-by: Chen Wang

[github][ci]: add concurrency control to GitHub Actions (#10761)

2025-10-01T03:00:07Z

ci: add concurrency control to GitHub Actions

[RFC][doxygen]Doxygen comment standard processing (#10058)

2025-03-01T08:02:17Z

Signed-off-by: 1078249029 <1078249029@qq.com>

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: 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] doxygen attach github pages (#9859)

2025-01-03T04:09:40Z

* [doc] doxygen attach github pages * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml * Update doxygen.yml

doc(doxyge):fix doxygen path

2024-12-09T22:12:59Z

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

2024-09-15T00:22:44Z

[doc][doxygen]: Fix doxygen warning in comment

2024-06-25T17:21:57Z

kservice.c:474: warning: The following parameter of rt_backtrace_to_buffer(rt_thread_t thread, struct rt_hw_backtrace_frame *frame, long skip, rt_ubase_t *buffer, long buflen) is not documented: parameter 'thread' kernel.h:157: warning: unable to resolve reference to '_rt_errno' for \ref command Signed-off-by: supperthomas <78900636@qq.com>

[ci] fix doxygen ci grammar error

2024-04-25T02:13:13Z