Browse Source

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 <unicorn_wang@outlook.com>
Chen Wang 4 weeks ago
parent
commit
e234cc8658
3 changed files with 11 additions and 5 deletions
  1. 9 3
      documentation/0.doxygen/2.components.h
  2. 1 1
      include/rtdef.h
  3. 1 1
      include/rtthread.h

+ 9 - 3
documentation/0.doxygen/2.components.h

@@ -1,6 +1,12 @@
 /*
  * This file is only used for doxygen document generation.
- */
+ *
+ * Components
+ * - Device Virtual File System
+ * - Device Driver
+ * - Finsh Shell
+ * - Application Module
+  */
 
 /**
  * @defgroup group_kernel_components Components
@@ -31,7 +37,7 @@
  */
 
 /**
- * @defgroup group_Device Device System
+ * @defgroup group_device_driver Device Driver
  * @brief device I/O subsystem
  *
  * The Device System is designed as simple and minimum layer to help communication between
@@ -46,7 +52,7 @@
  */
 
 /**
- * @defgroup group_finsh finsh shell
+ * @defgroup group_finsh Finsh Shell
  *
  * @brief finsh shell is a user command shell in RT-Thread RTOS.
  *

+ 1 - 1
include/rtdef.h

@@ -1237,7 +1237,7 @@ typedef struct rt_mempool *rt_mp_t;
 
 #ifdef RT_USING_DEVICE
 /**
- * @addtogroup group_Device
+ * @addtogroup group_device_driver
  */
 
 /**@{*/

+ 1 - 1
include/rtthread.h

@@ -663,7 +663,7 @@ void rt_spin_unlock_irqrestore(struct rt_spinlock *lock, rt_base_t level);
 
 #ifdef RT_USING_DEVICE
 /**
- * @addtogroup group_Device
+ * @addtogroup group_device_driver
  * @{
  */