mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-10-16 23:40:13 +08:00
doxygen: add prefix for groups (#9991)
* 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>
This commit is contained in:
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup BasicDef Basic Definitions
|
||||
* @defgroup group_BasicDef Basic Definitions
|
||||
*
|
||||
* @brief Basic data type in RT-Thread RTOS.
|
||||
*
|
||||
|
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup DFS Device Virtual File System
|
||||
* @defgroup group_DFS Device Virtual File System
|
||||
*
|
||||
* @brief DFS is a virtual file system in RT-Thread RTOS.
|
||||
*
|
||||
@@ -20,25 +20,25 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup DFS
|
||||
* @addtogroup group_DFS
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Fd File Descriptor
|
||||
* @defgroup group_Fd File Descriptor
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup FsApi File System API
|
||||
* @defgroup group_FsApi File System API
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup FileApi File API
|
||||
* @defgroup group_FileApi File API
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup FsPosixApi File POSIX API
|
||||
* @defgroup group_FsPosixApi File POSIX API
|
||||
*/
|
||||
|
||||
/**@}*/
|
||||
|
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup finsh finsh shell
|
||||
* @defgroup group_finsh finsh shell
|
||||
*
|
||||
* @brief finsh shell is a user command shell in RT-Thread RTOS.
|
||||
*
|
||||
|
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup bsp Hardware Related Package
|
||||
* @defgroup group_bsp Hardware Related Package
|
||||
*
|
||||
* @brief Hardware Related Package includes board support package(BSP) and CSP(Chip
|
||||
* Support Package).
|
||||
@@ -18,7 +18,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup bsp
|
||||
* @addtogroup group_bsp
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Kernel RT-Thread Kernel API
|
||||
* @defgroup group_Kernel RT-Thread Kernel API
|
||||
*
|
||||
* The Kernel APIs are the core APIs of RT-Thread, which supports the following
|
||||
* features:
|
||||
@@ -15,12 +15,12 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup Kernel
|
||||
* @addtogroup group_Kernel
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Thread Thread Management
|
||||
* @defgroup group_Thread Thread Management
|
||||
* @brief the thread management
|
||||
*
|
||||
* RT-Thread operating system supports multitask systems, which are based on thread
|
||||
@@ -40,7 +40,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Clock Clock and Timer Management
|
||||
* @defgroup group_Clock Clock and Timer Management
|
||||
* @brief clock and system timer management
|
||||
*
|
||||
* RT-Thread uses clock tick to implement shared time-slice scheduling.
|
||||
@@ -50,7 +50,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup KernelObject Kernel Object Management
|
||||
* @defgroup group_KernelObject Kernel Object Management
|
||||
* @brief kernel object management
|
||||
*
|
||||
* The Kernel object system can access and manage all of the kernel objects.
|
||||
@@ -70,7 +70,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup IPC Inter-Thread Communication
|
||||
* @defgroup group_IPC Inter-Thread Communication
|
||||
* @brief inter-thread communication
|
||||
*
|
||||
* RT-Thread operating system supports the traditional semaphore and mutex.
|
||||
@@ -96,7 +96,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Signal Signal
|
||||
* @defgroup group_Signal Signal
|
||||
* @brief signal is used for thread kill etc.
|
||||
*
|
||||
* A signal (also known as a soft interrupt signal), from a software perspective,
|
||||
@@ -105,7 +105,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MM Memory Management
|
||||
* @defgroup group_MM Memory Management
|
||||
* @brief memory management for memory pool and heap memory
|
||||
*
|
||||
* RT-Thread operating system supports two types memory management:
|
||||
@@ -124,7 +124,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Device Device System
|
||||
* @defgroup group_Device Device System
|
||||
* @brief device I/O subsystem
|
||||
*
|
||||
* The Device System is designed as simple and minimum layer to help communication between
|
||||
@@ -139,7 +139,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Hook Runtime Trace and Record
|
||||
* @defgroup group_Hook Runtime Trace and Record
|
||||
* @brief the hook function set in runtime
|
||||
*
|
||||
* In order to trace and record RT-Thread activity in runtime, a hook mechanism
|
||||
@@ -154,12 +154,12 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup KernelService Other useful kernel service
|
||||
* @defgroup group_KernelService Other useful kernel service
|
||||
* @brief other useful service in the kernel
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Error Error Code
|
||||
* @defgroup group_Error Error Code
|
||||
* @brief error code
|
||||
*
|
||||
* The error code is defined to identify which kind of error occurs. When some
|
||||
|
@@ -38,12 +38,12 @@
|
||||
* - Memory management, memory pool and dynamic heap memory management
|
||||
* - Asynchronous timer
|
||||
*
|
||||
* For more details, please refer to @ref Kernel
|
||||
* 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 SystemInit
|
||||
* For more details, please refer to @ref group_SystemInit
|
||||
*/
|
||||
|
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Module Application Module
|
||||
* @defgroup group_Module Application Module
|
||||
*
|
||||
* @brief Application Module is a feature let user to execute application in RT-Thread RTOS.
|
||||
*
|
||||
|
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup SystemInit System Initialization
|
||||
* @defgroup group_SystemInit System Initialization
|
||||
*
|
||||
* @brief System initialization procedure.
|
||||
*
|
||||
@@ -47,7 +47,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup SystemInit
|
||||
* @ingroup group_SystemInit
|
||||
*
|
||||
* This function will initialize user application.
|
||||
*
|
||||
@@ -58,6 +58,6 @@
|
||||
void rt_application_init();
|
||||
|
||||
/**
|
||||
* @ingroup SystemInit
|
||||
* @ingroup group_SystemInit
|
||||
*/
|
||||
void rt_system_heap_init(void* begin_addr, void* end_addr);
|
||||
|
@@ -3,7 +3,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* @addtogroup Thread
|
||||
* @addtogroup group_Thread
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
Reference in New Issue
Block a user