From 4ff1cfce641b681c1cbe5f20b45beab45d1eae90 Mon Sep 17 00:00:00 2001 From: Chen Wang Date: Fri, 11 Apr 2025 16:38:27 +0800 Subject: [PATCH] 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 --- .../0.doxygen/{ => example}/INDEX.md | 0 .../0.doxygen/{ => example}/doxygen.h | 0 documentation/0.doxygen/mainpage.h | 49 ------------------- 3 files changed, 49 deletions(-) rename documentation/0.doxygen/{ => example}/INDEX.md (100%) rename documentation/0.doxygen/{ => example}/doxygen.h (100%) delete mode 100644 documentation/0.doxygen/mainpage.h diff --git a/documentation/0.doxygen/INDEX.md b/documentation/0.doxygen/example/INDEX.md similarity index 100% rename from documentation/0.doxygen/INDEX.md rename to documentation/0.doxygen/example/INDEX.md diff --git a/documentation/0.doxygen/doxygen.h b/documentation/0.doxygen/example/doxygen.h similarity index 100% rename from documentation/0.doxygen/doxygen.h rename to documentation/0.doxygen/example/doxygen.h diff --git a/documentation/0.doxygen/mainpage.h b/documentation/0.doxygen/mainpage.h deleted file mode 100644 index 1033cab17c..0000000000 --- a/documentation/0.doxygen/mainpage.h +++ /dev/null @@ -1,49 +0,0 @@ -/* - * This file is only used for doxygen document generation. - */ - -/** - * @mainpage Introduction - * @author RT-Thread Development Team - * @version 1.2.0 - * - * RT-Thread RTOS is an open source embedded real-time operating system and is - * designed specifically for small memory footprint platforms. The real-time and - * embedded characters are the most significant advantages of RT-Thread. - * - * - Real-Time Character - * - * RT-Thread has a real-time operating system kernel, with fully preempted - * multi-thread scheduler, inter-thread communication with timing sensitivity - * and transparent interrupt handling. - * - * - Embedded Character - * - * RT-Thread is suitable for embedded systems for small footprint characters. - * The kernel is implemented as a simple C library. The simplest application - * costs less than 1 Kbytes RAM on the ARM Cortex-M platform. - * - * @section kernel_arch RT-Thread Architecture - * - * RT-Thread system architecture is like: - * @image html System_Arch.png "Figure 1: RT-Thread Architecture" - * - * @section kernel_service Kernel API - * - * The Kernel APIs are the core APIs of RT-Thread, which supports the following - * features: - * - Multi-thread management and scheduler - * - Synchronization mechanisms, semaphore, recursive mutex and event set - * - Inter-thread communication, mailbox and message queue - * - Memory management, memory pool and dynamic heap memory management - * - Asynchronous timer - * - * For more details, please refer to @ref group_Kernel - * - * @section system_init System Initialization - * - * Once RT-Thread operating system starts up, the facility in system must be initialized - * firstly. - * - * For more details, please refer to @ref group_SystemInit - */