Skip to content

Commit e234cc8

Browse files
unicornxRbb666
authored andcommitted
doxygen: change group_Device to group_device_driver
The originally defined "group_Device" should actually be part of the device-driver component, so create a new "group_device_driver" and then rename "group_Device" to "group_device_driver". Signed-off-by: Chen Wang <[email protected]>
1 parent dcf637d commit e234cc8

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

documentation/0.doxygen/2.components.h

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
/*
22
* This file is only used for doxygen document generation.
3-
*/
3+
*
4+
* Components
5+
* - Device Virtual File System
6+
* - Device Driver
7+
* - Finsh Shell
8+
* - Application Module
9+
*/
410

511
/**
612
* @defgroup group_kernel_components Components
@@ -31,7 +37,7 @@
3137
*/
3238

3339
/**
34-
* @defgroup group_Device Device System
40+
* @defgroup group_device_driver Device Driver
3541
* @brief device I/O subsystem
3642
*
3743
* The Device System is designed as simple and minimum layer to help communication between
@@ -46,7 +52,7 @@
4652
*/
4753

4854
/**
49-
* @defgroup group_finsh finsh shell
55+
* @defgroup group_finsh Finsh Shell
5056
*
5157
* @brief finsh shell is a user command shell in RT-Thread RTOS.
5258
*

include/rtdef.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1237,7 +1237,7 @@ typedef struct rt_mempool *rt_mp_t;
12371237

12381238
#ifdef RT_USING_DEVICE
12391239
/**
1240-
* @addtogroup group_Device
1240+
* @addtogroup group_device_driver
12411241
*/
12421242

12431243
/**@{*/

include/rtthread.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -663,7 +663,7 @@ void rt_spin_unlock_irqrestore(struct rt_spinlock *lock, rt_base_t level);
663663

664664
#ifdef RT_USING_DEVICE
665665
/**
666-
* @addtogroup group_Device
666+
* @addtogroup group_device_driver
667667
* @{
668668
*/
669669

0 commit comments

Comments
 (0)