rt-thread

mirror of https://github.com/RT-Thread/rt-thread.git synced 2026-10-15 18:53:09 +08:00

Author	SHA1	Message	Date
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 AutoTestCI / components/cpp11 (push) Waiting to run AutoTestCI / kernel/atomic (push) Waiting to run AutoTestCI / kernel/atomic/riscv64 (push) Waiting to run AutoTestCI / kernel/atomic_c11 (push) Waiting to run AutoTestCI / kernel/atomic_c11/riscv64 (push) Waiting to run AutoTestCI / kernel/device (push) Waiting to run AutoTestCI / kernel/ipc (push) Waiting to run AutoTestCI / kernel/irq (push) Waiting to run AutoTestCI / kernel/mem (push) Waiting to run AutoTestCI / kernel/mem/riscv64 (push) Waiting to run AutoTestCI / kernel/thread (push) Waiting to run AutoTestCI / kernel/timer (push) Waiting to run AutoTestCI / rtsmart/aarch64 (push) Waiting to run AutoTestCI / rtsmart/arm (push) Waiting to run AutoTestCI / rtsmart/riscv64 (push) Waiting to run AutoTestCI / components/utest (push) Waiting to run RT-Thread BSP Static Build Check / ESP32C3 (push) Waiting to run RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Waiting to run RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Waiting to run RT-Thread BSP Static Build Check / aarch64 (push) Waiting to run RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Waiting to run RT-Thread BSP Static Build Check / hpmicro (push) Waiting to run RT-Thread BSP Static Build Check / i386-unknown (push) Waiting to run RT-Thread BSP Static Build Check / llvm-arm (push) Waiting to run RT-Thread BSP Static Build Check / mips (push) Waiting to run RT-Thread BSP Static Build Check / nordic(yml) (push) Waiting to run RT-Thread BSP Static Build Check / nuvoton (push) Waiting to run RT-Thread BSP Static Build Check / nxp_renesas (push) Waiting to run RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Waiting to run RT-Thread BSP Static Build Check / riscv-none (push) Waiting to run RT-Thread BSP Static Build Check / riscv64-unknown (push) Waiting to run RT-Thread BSP Static Build Check / simulator (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Waiting to run RT-Thread BSP Static Build Check / stm32f0_f1 (push) Waiting to run RT-Thread BSP Static Build Check / stm32l4 (push) Waiting to run BSP compilation with more drivers / BSP Compilation with More Drivers (push) Waiting to run pkgs_test / change (push) Has been skipped doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled 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
wumingzi	600e4ab517	Add recommanded script and extension for writing doxygen comments on … (#10001 ) Add recommanded script and extension for writing doxygen comments on vscode Signed-off-by: 1078249029 <1078249029@qq.com>	2025-02-19 09:06:15 +08:00
Chen Wang	c40b79037c	doxygen: add prefix for groups (#9991 ) pkgs_test / change (push) Has been skipped AutoTestCI / components/cpp11 (push) Has been cancelled AutoTestCI / kernel/atomic (push) Has been cancelled AutoTestCI / kernel/atomic/riscv64 (push) Has been cancelled AutoTestCI / kernel/atomic_c11 (push) Has been cancelled AutoTestCI / kernel/atomic_c11/riscv64 (push) Has been cancelled AutoTestCI / kernel/device (push) Has been cancelled AutoTestCI / kernel/ipc (push) Has been cancelled AutoTestCI / kernel/irq (push) Has been cancelled AutoTestCI / kernel/mem (push) Has been cancelled AutoTestCI / kernel/mem/riscv64 (push) Has been cancelled AutoTestCI / kernel/thread (push) Has been cancelled AutoTestCI / kernel/timer (push) Has been cancelled AutoTestCI / rtsmart/aarch64 (push) Has been cancelled AutoTestCI / rtsmart/arm (push) Has been cancelled AutoTestCI / rtsmart/riscv64 (push) Has been cancelled AutoTestCI / components/utest (push) Has been cancelled RT-Thread BSP Static Build Check / ESP32C3 (push) Has been cancelled RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Has been cancelled RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Has been cancelled RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Has been cancelled RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Has been cancelled RT-Thread BSP Static Build Check / aarch64 (push) Has been cancelled RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Has been cancelled RT-Thread BSP Static Build Check / hpmicro (push) Has been cancelled RT-Thread BSP Static Build Check / i386-unknown (push) Has been cancelled RT-Thread BSP Static Build Check / llvm-arm (push) Has been cancelled RT-Thread BSP Static Build Check / mips (push) Has been cancelled RT-Thread BSP Static Build Check / nordic(yml) (push) Has been cancelled RT-Thread BSP Static Build Check / nuvoton (push) Has been cancelled RT-Thread BSP Static Build Check / nxp_renesas (push) Has been cancelled RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Has been cancelled RT-Thread BSP Static Build Check / riscv-none (push) Has been cancelled RT-Thread BSP Static Build Check / riscv64-unknown (push) Has been cancelled RT-Thread BSP Static Build Check / simulator (push) Has been cancelled RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Has been cancelled RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Has been cancelled RT-Thread BSP Static Build Check / stm32l4_f0_f1 (push) Has been cancelled BSP compilation with more drivers / BSP Compilation with More Drivers (push) Has been cancelled doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled * 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 <unicorn_wang@outlook.com> * 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 <unicorn_wang@outlook.com> --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-15 12:15:19 +08:00
Chen Wang	f6f7d91a61	doxygen: add prefix for page name (#9989 ) doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled Add prefix "page_" to the name of pages. Add this as a rule in guide of writing doxygen documents. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-13 23:28:19 +08:00
Chen Wang	761bb89f27	doxygen: add documentation for doxygen ToolsCI / Tools (push) Waiting to run AutoTestCI / components/cpp11 (push) Waiting to run AutoTestCI / kernel/atomic (push) Waiting to run AutoTestCI / kernel/atomic/riscv64 (push) Waiting to run AutoTestCI / kernel/atomic_c11 (push) Waiting to run AutoTestCI / kernel/atomic_c11/riscv64 (push) Waiting to run AutoTestCI / kernel/device (push) Waiting to run AutoTestCI / kernel/ipc (push) Waiting to run AutoTestCI / kernel/irq (push) Waiting to run AutoTestCI / kernel/mem (push) Waiting to run AutoTestCI / kernel/mem/riscv64 (push) Waiting to run AutoTestCI / kernel/thread (push) Waiting to run AutoTestCI / kernel/timer (push) Waiting to run AutoTestCI / rtsmart/aarch64 (push) Waiting to run AutoTestCI / rtsmart/arm (push) Waiting to run AutoTestCI / rtsmart/riscv64 (push) Waiting to run AutoTestCI / components/utest (push) Waiting to run RT-Thread BSP Static Build Check / ESP32C3 (push) Waiting to run RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Waiting to run RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Waiting to run RT-Thread BSP Static Build Check / aarch64 (push) Waiting to run RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Waiting to run RT-Thread BSP Static Build Check / hpmicro (push) Waiting to run RT-Thread BSP Static Build Check / i386-unknown (push) Waiting to run RT-Thread BSP Static Build Check / llvm-arm (push) Waiting to run RT-Thread BSP Static Build Check / mips (push) Waiting to run RT-Thread BSP Static Build Check / nordic(yml) (push) Waiting to run RT-Thread BSP Static Build Check / nuvoton (push) Waiting to run RT-Thread BSP Static Build Check / nxp_renesas (push) Waiting to run RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Waiting to run RT-Thread BSP Static Build Check / riscv-none (push) Waiting to run RT-Thread BSP Static Build Check / riscv64-unknown (push) Waiting to run RT-Thread BSP Static Build Check / simulator (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Waiting to run RT-Thread BSP Static Build Check / stm32l4_f0_f1 (push) Waiting to run BSP compilation with more drivers / BSP Compilation with More Drivers (push) Waiting to run pkgs_test / change (push) Has been skipped doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled 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
Chen WangandSupper Thomas	40f3b6a569	doxygen: create framework to unify markdown and source code part (#9946 ) ToolsCI / Tools (push) Waiting to run AutoTestCI / components/cpp11 (push) Waiting to run AutoTestCI / kernel/atomic (push) Waiting to run AutoTestCI / kernel/atomic/riscv64 (push) Waiting to run AutoTestCI / kernel/atomic_c11 (push) Waiting to run AutoTestCI / kernel/atomic_c11/riscv64 (push) Waiting to run AutoTestCI / kernel/device (push) Waiting to run AutoTestCI / kernel/ipc (push) Waiting to run AutoTestCI / kernel/irq (push) Waiting to run AutoTestCI / kernel/mem (push) Waiting to run AutoTestCI / kernel/mem/riscv64 (push) Waiting to run AutoTestCI / kernel/thread (push) Waiting to run AutoTestCI / kernel/timer (push) Waiting to run AutoTestCI / rtsmart/aarch64 (push) Waiting to run AutoTestCI / rtsmart/arm (push) Waiting to run AutoTestCI / rtsmart/riscv64 (push) Waiting to run AutoTestCI / components/utest (push) Waiting to run RT-Thread BSP Static Build Check / ESP32C3 (push) Waiting to run RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Waiting to run RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Waiting to run RT-Thread BSP Static Build Check / aarch64 (push) Waiting to run RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Waiting to run RT-Thread BSP Static Build Check / hpmicro (push) Waiting to run RT-Thread BSP Static Build Check / i386-unknown (push) Waiting to run RT-Thread BSP Static Build Check / llvm-arm (push) Waiting to run RT-Thread BSP Static Build Check / mips (push) Waiting to run RT-Thread BSP Static Build Check / nordic(yml) (push) Waiting to run RT-Thread BSP Static Build Check / nuvoton (push) Waiting to run RT-Thread BSP Static Build Check / nxp_renesas (push) Waiting to run RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Waiting to run RT-Thread BSP Static Build Check / riscv-none (push) Waiting to run RT-Thread BSP Static Build Check / riscv64-unknown (push) Waiting to run RT-Thread BSP Static Build Check / simulator (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Waiting to run RT-Thread BSP Static Build Check / stm32l4_f0_f1 (push) Waiting to run BSP compilation with more drivers / BSP Compilation with More Drivers (push) Waiting to run pkgs_test / change (push) Waiting to run doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled * 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