mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-02-24 15:27:04 +08:00
40f3b6a569
* 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>
50 lines
1.7 KiB
C
50 lines
1.7 KiB
C
/*
|
|
* 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 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 SystemInit
|
|
*/
|