doxygen: group name all in lowcase (part 2) (#10530)

unicornx · web-flow · commit 2aebe694d9a6 · 2025-07-22T13:59:25.000+08:00
* doxygen: fs: unify groupname to lowercase

Signed-off-by: Chen Wang &lt;unicorn_wang@outlook.com&gt;

* doxygen: drivers: unify groupname to lowercase

Signed-off-by: Chen Wang &lt;unicorn_wang@outlook.com&gt;

* doxygen: signal: unify groupname to lowercase

Signed-off-by: Chen Wang &lt;unicorn_wang@outlook.com&gt;

---------

Signed-off-by: Chen Wang &lt;unicorn_wang@outlook.com&gt;
diff --git a/components/dfs/dfs_v1/src/dfs.c b/components/dfs/dfs_v1/src/dfs.c
@@ -297,7 +297,7 @@ static int fd_alloc(struct dfs_fdtable *fdt, int startfd)
 }
 
 /**
- * @ingroup group_Fd
+ * @ingroup group_fs_file_descriptor
  * This function will allocate a file descriptor.
  *
  * @return -1 on failed or the allocated file descriptor.
@@ -331,7 +331,7 @@ int fd_new(void)
 }
 
 /**
- * @ingroup group_Fd
+ * @ingroup group_fs_file_descriptor
  *
  * This function will return a file descriptor structure according to file
  * descriptor.
@@ -373,7 +373,7 @@ struct dfs_file *fd_get(int fd)
 }
 
 /**
- * @ingroup group_Fd
+ * @ingroup group_fs_file_descriptor
  *
  * @brief This function will release the file descriptor.
  *
@@ -480,7 +480,7 @@ rt_err_t sys_dup(int oldfd)
 #endif /* DFS_USING_POSIX */
 
 /**
- * @ingroup group_Fd
+ * @ingroup group_fs_file_descriptor
  *
  * This function will return whether this file has been opend.
  *
diff --git a/components/dfs/dfs_v1/src/dfs_file.c b/components/dfs/dfs_v1/src/dfs_file.c
@@ -141,7 +141,7 @@ static struct dfs_vnode *dfs_vnode_find(const char *path, rt_list_t **hash_head)
 }
 
 /**
- * @addtogroup group_FileApi
+ * @addtogroup group_fs_file_api
  * @{
  */
 
diff --git a/components/dfs/dfs_v1/src/dfs_fs.c b/components/dfs/dfs_v1/src/dfs_fs.c
@@ -17,7 +17,7 @@
 #include "dfs_private.h"
 
 /**
- * @addtogroup group_FsApi
+ * @addtogroup group_fs_api
  * @{
  */
 
diff --git a/components/dfs/dfs_v1/src/dfs_posix.c b/components/dfs/dfs_v1/src/dfs_posix.c
@@ -19,7 +19,7 @@
 #endif
 
 /**
- * @addtogroup group_FsPosixApi
+ * @addtogroup group_fs_posix_api
  * @{
  */
 
diff --git a/components/dfs/dfs_v2/src/dfs.c b/components/dfs/dfs_v2/src/dfs.c
@@ -218,7 +218,7 @@ void dfs_file_destroy(struct dfs_file *file)
 }
 
 /**
- * @ingroup group_Fd
+ * @ingroup group_fs_file_descriptor
  * This function will allocate a file descriptor.
  *
  * @return -1 on failed or the allocated file descriptor.
@@ -291,7 +291,7 @@ void fdt_fd_release(struct dfs_fdtable *fdt, int fd)
 }
 
 /**
- * @ingroup group_Fd
+ * @ingroup group_fs_file_descriptor
  *
  * This function will return a file descriptor structure according to file
  * descriptor.
@@ -369,7 +369,7 @@ int fd_new(void)
 }
 
 /**
- * @ingroup group_Fd
+ * @ingroup group_fs_file_descriptor
  *
  * This function will put the file descriptor.
  */
diff --git a/components/dfs/dfs_v2/src/dfs_fs.c b/components/dfs/dfs_v2/src/dfs_fs.c
@@ -31,7 +31,7 @@ static struct dfs_filesystem_type *file_systems = NULL;
 extern rt_list_t _mnt_list;
 
 /**
- * @addtogroup group_FsApi
+ * @addtogroup group_fs_api
  */
 /*@{*/
 
diff --git a/components/dfs/dfs_v2/src/dfs_posix.c b/components/dfs/dfs_v2/src/dfs_posix.c
@@ -22,7 +22,7 @@
 #endif
 
 /**
- * @addtogroup group_FsPosixApi
+ * @addtogroup group_fs_posix_api
  * @{
  */
 
diff --git a/components/drivers/audio/dev_audio.c b/components/drivers/audio/dev_audio.c
@@ -24,7 +24,7 @@
 #endif
 
 /**
- * @addtogroup group_Audio
+ * @addtogroup group_drivers_audio
  */
 
 /** @{ */
@@ -781,4 +781,4 @@ void rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt_size_t
         audio->parent.rx_indicate(&audio->parent, len);
 }
 
-/** @} group_Audio */
+/** @} group_drivers_audio */
diff --git a/components/drivers/include/drivers/adc.h b/components/drivers/include/drivers/adc.h
@@ -15,7 +15,7 @@
 
 #include <rtthread.h>
 /**
- * @defgroup    group_ADC ADC
+ * @defgroup    group_drivers_adc ADC
  * @brief       ADC driver api
  * @ingroup     group_device_driver
  *
@@ -60,7 +60,7 @@
 
 
 /*!
- * @addtogroup group_ADC
+ * @addtogroup group_drivers_adc
  * @{
  */
 #define RT_ADC_INTERN_CH_TEMPER     (-1)
@@ -103,7 +103,7 @@ typedef enum
  * @param ops device ops
  * @param user_data device private data
  * @return rt_err_t        error code
- * @ingroup group_ADC
+ * @ingroup group_drivers_adc
  */
 rt_err_t rt_hw_adc_register(rt_adc_device_t adc,const char *name, const struct rt_adc_ops *ops, const void *user_data);
 
@@ -112,7 +112,7 @@ rt_err_t rt_hw_adc_register(rt_adc_device_t adc,const char *name, const struct r
  * @param dev adc device
  * @param channel adc channel
  * @return rt_uint32_t adc value
- * @ingroup group_ADC
+ * @ingroup group_drivers_adc
  */
 rt_uint32_t rt_adc_read(rt_adc_device_t dev, rt_int8_t channel);
 
@@ -121,7 +121,7 @@ rt_uint32_t rt_adc_read(rt_adc_device_t dev, rt_int8_t channel);
  * @param dev adc device
  * @param channel adc channel
  * @return rt_err_t error code
- * @ingroup group_ADC
+ * @ingroup group_drivers_adc
  */
 rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);
 
@@ -130,7 +130,7 @@ rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);
  * @param dev adc device
  * @param channel adc channel
  * @return rt_err_t error code
- * @ingroup group_ADC
+ * @ingroup group_drivers_adc
  */
 rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);
 
@@ -139,7 +139,7 @@ rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);
  * @param dev adc device
  * @param channel adc channel
  * @return rt_int16_t adc resolution
- * @ingroup group_ADC
+ * @ingroup group_drivers_adc
  */
 rt_int16_t rt_adc_voltage(rt_adc_device_t dev, rt_int8_t channel);
 
diff --git a/components/drivers/include/drivers/dac.h b/components/drivers/include/drivers/dac.h
@@ -12,7 +12,7 @@
 #define __DAC_H__
 #include <rtthread.h>
 /**
- * @defgroup    group_DAC DAC
+ * @defgroup    group_drivers_dac DAC
  * @brief       DAC driver api
  * @ingroup     group_device_driver
  *
@@ -61,7 +61,7 @@
  */
 
 /*!
- * @addtogroup group_DAC
+ * @addtogroup group_drivers_dac
  * @{
  */
 struct rt_dac_device;
diff --git a/components/drivers/include/drivers/dev_audio.h b/components/drivers/include/drivers/dev_audio.h
@@ -16,7 +16,7 @@
 #include "dev_audio_pipe.h"
 
 /**
- * @defgroup    group_Audio Audio
+ * @defgroup    group_drivers_audio Audio
  * @brief       Audio driver API.
  * @ingroup     group_device_driver
  *
@@ -286,6 +286,6 @@ void        rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt
 #define CODEC_VOLUME_MAX            (63)
 /** @} */ /* End of group_audio_codec_cmd */
 
-/** @} group_Audio */
+/** @} group_drivers_audio */
 
 #endif /* __DEV_AUDIO_H__ */
diff --git a/components/drivers/include/drivers/dev_can.h b/components/drivers/include/drivers/dev_can.h
@@ -64,7 +64,7 @@ enum CANBAUD
 #define RT_CAN_MODE_NOPRIV              0x00
 
 /**
- * @defgroup    group_CAN_Device CAN Driver
+ * @defgroup    group_drivers_can CAN Driver
  * @brief       CAN driver api
  * @ingroup     group_device_driver
  *
@@ -201,7 +201,7 @@ enum CANBAUD
 
 
 /*!
- * @addtogroup group_CAN_Device
+ * @addtogroup group_drivers_can
  * @{
  */
 #define CAN_RX_FIFO0                (0x00000000U)  /*!< CAN receive FIFO 0 */
diff --git a/components/drivers/include/drivers/dev_i2c.h b/components/drivers/include/drivers/dev_i2c.h
@@ -14,7 +14,7 @@
 
 #include <rtthread.h>
 /**
- * @defgroup    group_I2C I2C
+ * @defgroup    group_drivers_i2c I2C
  * @brief       I2C driver api
  * @ingroup     group_device_driver
  *
@@ -170,7 +170,7 @@
  */
 
 /*!
- * @addtogroup group_I2C
+ * @addtogroup group_drivers_i2c
  * @{
  */
 #ifdef __cplusplus
diff --git a/components/drivers/include/drivers/dev_pin.h b/components/drivers/include/drivers/dev_pin.h
@@ -15,7 +15,7 @@
 #include <rtthread.h>
 
 /**
- * @defgroup    group_Pin Pin
+ * @defgroup    group_drivers_pin Pin
  * @brief       Pin driver api
  * @ingroup     group_device_driver
  *
@@ -69,7 +69,7 @@
  */
 
 /*!
- * @addtogroup group_Pin
+ * @addtogroup group_drivers_pin
  * @{
  */
 #ifdef __cplusplus
diff --git a/components/drivers/include/drivers/dev_pwm.h b/components/drivers/include/drivers/dev_pwm.h
@@ -14,7 +14,7 @@
 
 #include <rtthread.h>
 /**
- * @defgroup    group_PWM PWM
+ * @defgroup    group_drivers_pwm PWM
  * @brief       PWM driver api
  * @ingroup     group_device_driver
  *
@@ -79,7 +79,7 @@
  */
 
 /*!
- * @addtogroup group_PWM
+ * @addtogroup group_drivers_pwm
  * @{
  */
 #define PWM_CMD_ENABLE      (RT_DEVICE_CTRL_BASE(PWM) + 0)
diff --git a/components/drivers/include/drivers/dev_rtc.h b/components/drivers/include/drivers/dev_rtc.h
@@ -17,7 +17,7 @@
 #include <rtdef.h>
 #include <sys/time.h>
 /**
- * @defgroup    group_RTC RTC
+ * @defgroup    group_drivers_rtc RTC
  * @brief       RTC driver api
  * @ingroup     group_device_driver
  *
@@ -74,7 +74,7 @@
  */
 
 /*!
- * @addtogroup group_RTC
+ * @addtogroup group_drivers_rtc
  * @{
  */
 #ifdef __cplusplus
diff --git a/components/drivers/include/drivers/dev_serial.h b/components/drivers/include/drivers/dev_serial.h
@@ -16,7 +16,7 @@
 
 #include <rtthread.h>
 /**
- * @defgroup    group_Serial Serial
+ * @defgroup    group_drivers_serial Serial
  * @brief       Serial driver api
  * @ingroup     group_device_driver
  *
@@ -108,7 +108,7 @@
 
 
 /*!
- * @addtogroup group_Serial
+ * @addtogroup group_drivers_serial
  * @{
  */
 #define BAUD_RATE_2400                  2400
@@ -286,7 +286,7 @@ struct rt_uart_ops
  * @brief Serial interrupt service routine
  * @param serial    serial device
  * @param event     event mask
- * @ingroup group_Serial
+ * @ingroup group_drivers_serial
  */
 void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
 
@@ -300,7 +300,7 @@ void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
  * @return rt_err_t        error code
  * @note This function will register a serial device to system device list,
  *       and add a device object to system object list.
- * @ingroup group_Serial
+ * @ingroup group_drivers_serial
  */
 rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
                                const char              *name,
@@ -313,7 +313,7 @@ rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
  * @param serial    serial device
  * @return rt_err_t error code
  *
- * @ingroup group_Serial
+ * @ingroup group_drivers_serial
  */
 rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial);
 
diff --git a/components/drivers/include/drivers/dev_serial_v2.h b/components/drivers/include/drivers/dev_serial_v2.h
diff --git a/components/drivers/include/drivers/dev_spi.h b/components/drivers/include/drivers/dev_spi.h
diff --git a/components/drivers/include/drivers/dev_touch.h b/components/drivers/include/drivers/dev_touch.h
diff --git a/documentation/0.doxygen/components/filesystem.h b/documentation/0.doxygen/components/filesystem.h
diff --git a/documentation/0.doxygen/core/ipc.h b/documentation/0.doxygen/core/ipc.h
diff --git a/documentation/6.components/device-driver/audio/audio.md b/documentation/6.components/device-driver/audio/audio.md
diff --git a/include/rtdef.h b/include/rtdef.h
diff --git a/include/rtthread.h b/include/rtthread.h

Original file line number	Diff line number	Diff line change
`@@ -297,7 +297,7 @@ static int fd_alloc(struct dfs_fdtable *fdt, int startfd)`
`297`	`297`	`}`
`298`	`298`
`299`	`299`	`/**`
`300`		`- * @ingroup group_Fd`
	`300`	`+ * @ingroup group_fs_file_descriptor`
`301`	`301`	`* This function will allocate a file descriptor.`
`302`	`302`	`*`
`303`	`303`	`* @return -1 on failed or the allocated file descriptor.`
`@@ -331,7 +331,7 @@ int fd_new(void)`
`331`	`331`	`}`
`332`	`332`
`333`	`333`	`/**`
`334`		`- * @ingroup group_Fd`
	`334`	`+ * @ingroup group_fs_file_descriptor`
`335`	`335`	`*`
`336`	`336`	`* This function will return a file descriptor structure according to file`
`337`	`337`	`* descriptor.`
`@@ -373,7 +373,7 @@ struct dfs_file *fd_get(int fd)`
`373`	`373`	`}`
`374`	`374`
`375`	`375`	`/**`
`376`		`- * @ingroup group_Fd`
	`376`	`+ * @ingroup group_fs_file_descriptor`
`377`	`377`	`*`
`378`	`378`	`* @brief This function will release the file descriptor.`
`379`	`379`	`*`
`@@ -480,7 +480,7 @@ rt_err_t sys_dup(int oldfd)`
`480`	`480`	`#endif /* DFS_USING_POSIX */`
`481`	`481`
`482`	`482`	`/**`
`483`		`- * @ingroup group_Fd`
	`483`	`+ * @ingroup group_fs_file_descriptor`
`484`	`484`	`*`
`485`	`485`	`* This function will return whether this file has been opend.`
`486`	`486`	`*`
Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ static struct dfs_vnode dfs_vnode_find(const char path, rt_list_t **hash_head)`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`/**`
`144`		`- * @addtogroup group_FileApi`
	`144`	`+ * @addtogroup group_fs_file_api`
`145`	`145`	`* @{`
`146`	`146`	`*/`
`147`	`147`
Original file line number	Diff line number	Diff line change
`@@ -218,7 +218,7 @@ void dfs_file_destroy(struct dfs_file *file)`
`218`	`218`	`}`
`219`	`219`
`220`	`220`	`/**`
`221`		`- * @ingroup group_Fd`
	`221`	`+ * @ingroup group_fs_file_descriptor`
`222`	`222`	`* This function will allocate a file descriptor.`
`223`	`223`	`*`
`224`	`224`	`* @return -1 on failed or the allocated file descriptor.`
`@@ -291,7 +291,7 @@ void fdt_fd_release(struct dfs_fdtable *fdt, int fd)`
`291`	`291`	`}`
`292`	`292`
`293`	`293`	`/**`
`294`		`- * @ingroup group_Fd`
	`294`	`+ * @ingroup group_fs_file_descriptor`
`295`	`295`	`*`
`296`	`296`	`* This function will return a file descriptor structure according to file`
`297`	`297`	`* descriptor.`
`@@ -369,7 +369,7 @@ int fd_new(void)`
`369`	`369`	`}`
`370`	`370`
`371`	`371`	`/**`
`372`		`- * @ingroup group_Fd`
	`372`	`+ * @ingroup group_fs_file_descriptor`
`373`	`373`	`*`
`374`	`374`	`* This function will put the file descriptor.`
`375`	`375`	`*/`