rt-thread

mirror of https://github.com/RT-Thread/rt-thread.git synced 2026-06-24 00:21:05 +08:00

Author	SHA1	Message	Date
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 Details AutoTestCI / kernel/atomic (push) Waiting to run Details AutoTestCI / kernel/atomic/riscv64 (push) Waiting to run Details AutoTestCI / kernel/atomic_c11 (push) Waiting to run Details AutoTestCI / kernel/atomic_c11/riscv64 (push) Waiting to run Details AutoTestCI / kernel/device (push) Waiting to run Details AutoTestCI / kernel/ipc (push) Waiting to run Details AutoTestCI / kernel/irq (push) Waiting to run Details AutoTestCI / kernel/mem (push) Waiting to run Details AutoTestCI / kernel/mem/riscv64 (push) Waiting to run Details AutoTestCI / kernel/thread (push) Waiting to run Details AutoTestCI / kernel/timer (push) Waiting to run Details AutoTestCI / rtsmart/aarch64 (push) Waiting to run Details AutoTestCI / rtsmart/arm (push) Waiting to run Details AutoTestCI / rtsmart/riscv64 (push) Waiting to run Details AutoTestCI / components/utest (push) Waiting to run Details RT-Thread BSP Static Build Check / ESP32C3 (push) Waiting to run Details RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Waiting to run Details RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Waiting to run Details RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Waiting to run Details RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Waiting to run Details RT-Thread BSP Static Build Check / aarch64 (push) Waiting to run Details RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Waiting to run Details RT-Thread BSP Static Build Check / hpmicro (push) Waiting to run Details RT-Thread BSP Static Build Check / i386-unknown (push) Waiting to run Details RT-Thread BSP Static Build Check / llvm-arm (push) Waiting to run Details RT-Thread BSP Static Build Check / mips (push) Waiting to run Details RT-Thread BSP Static Build Check / nordic(yml) (push) Waiting to run Details RT-Thread BSP Static Build Check / nuvoton (push) Waiting to run Details RT-Thread BSP Static Build Check / nxp_renesas (push) Waiting to run Details RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Waiting to run Details RT-Thread BSP Static Build Check / riscv-none (push) Waiting to run Details RT-Thread BSP Static Build Check / riscv64-unknown (push) Waiting to run Details RT-Thread BSP Static Build Check / simulator (push) Waiting to run Details RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Waiting to run Details RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Waiting to run Details RT-Thread BSP Static Build Check / stm32f0_f1 (push) Waiting to run Details RT-Thread BSP Static Build Check / stm32l4 (push) Waiting to run Details BSP compilation with more drivers / BSP Compilation with More Drivers (push) Waiting to run Details pkgs_test / change (push) Has been skipped Details doc_doxygen / doxygen_doc generate (push) Has been cancelled Details doc_doxygen / deploy (push) Has been cancelled Details 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 ToolsCI / Tools (push) Waiting to run Details AutoTestCI / components/cpp11 (push) Waiting to run Details AutoTestCI / kernel/atomic (push) Waiting to run Details AutoTestCI / kernel/atomic/riscv64 (push) Waiting to run Details AutoTestCI / kernel/atomic_c11 (push) Waiting to run Details AutoTestCI / kernel/atomic_c11/riscv64 (push) Waiting to run Details AutoTestCI / kernel/device (push) Waiting to run Details AutoTestCI / kernel/ipc (push) Waiting to run Details AutoTestCI / kernel/irq (push) Waiting to run Details AutoTestCI / kernel/mem (push) Waiting to run Details AutoTestCI / kernel/mem/riscv64 (push) Waiting to run Details AutoTestCI / kernel/thread (push) Waiting to run Details AutoTestCI / kernel/timer (push) Waiting to run Details AutoTestCI / rtsmart/aarch64 (push) Waiting to run Details AutoTestCI / rtsmart/arm (push) Waiting to run Details AutoTestCI / rtsmart/riscv64 (push) Waiting to run Details AutoTestCI / components/utest (push) Waiting to run Details RT-Thread BSP Static Build Check / ESP32C3 (push) Waiting to run Details RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Waiting to run Details RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Waiting to run Details RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Waiting to run Details RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Waiting to run Details RT-Thread BSP Static Build Check / aarch64 (push) Waiting to run Details RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Waiting to run Details RT-Thread BSP Static Build Check / hpmicro (push) Waiting to run Details RT-Thread BSP Static Build Check / i386-unknown (push) Waiting to run Details RT-Thread BSP Static Build Check / llvm-arm (push) Waiting to run Details RT-Thread BSP Static Build Check / mips (push) Waiting to run Details RT-Thread BSP Static Build Check / nordic(yml) (push) Waiting to run Details RT-Thread BSP Static Build Check / nuvoton (push) Waiting to run Details RT-Thread BSP Static Build Check / nxp_renesas (push) Waiting to run Details RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Waiting to run Details RT-Thread BSP Static Build Check / riscv-none (push) Waiting to run Details RT-Thread BSP Static Build Check / riscv64-unknown (push) Waiting to run Details RT-Thread BSP Static Build Check / simulator (push) Waiting to run Details RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Waiting to run Details RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Waiting to run Details RT-Thread BSP Static Build Check / stm32l4_f0_f1 (push) Waiting to run Details BSP compilation with more drivers / BSP Compilation with More Drivers (push) Waiting to run Details pkgs_test / change (push) Has been skipped Details doc_doxygen / doxygen_doc generate (push) Has been cancelled Details doc_doxygen / deploy (push) Has been cancelled Details 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

5 Commits