summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChen Wang <[email protected]>2025-05-29 09:21:19 +0800
committerRbb666 <[email protected]>2025-05-29 13:47:46 +0800
commite234cc865801940a78db8f5011845e336f22aeaf (patch)
tree0981a4bc5d893c92023d16f6ca902397ce8dca0c
parentdcf637dd30de8c0cf5d4cc5ddb0ddde0f12dcc17 (diff)
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]>
-rw-r--r--documentation/0.doxygen/2.components.h12
-rw-r--r--include/rtdef.h2
-rw-r--r--include/rtthread.h2
3 files changed, 11 insertions, 5 deletions
diff --git a/documentation/0.doxygen/2.components.h b/documentation/0.doxygen/2.components.h
index cc4fcff16e..131fa3bf11 100644
--- a/documentation/0.doxygen/2.components.h
+++ b/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.
*
diff --git a/include/rtdef.h b/include/rtdef.h
index 401a47be27..068ee17a47 100644
--- a/include/rtdef.h
+++ b/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
*/
/**@{*/
diff --git a/include/rtthread.h b/include/rtthread.h
index 103e26e894..aa7858d8cf 100644
--- a/include/rtthread.h
+++ b/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
* @{
*/