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>
RT-Thread · Feb 15, 2025 · c40b790 · c40b790
1 parent f6f7d91
commit c40b790
Show file tree

Hide file tree

Showing 47 changed files with 233 additions and 233 deletions.
diff --git a/components/dfs/dfs_v1/src/dfs.c b/components/dfs/dfs_v1/src/dfs.c
@@ -38,7 +38,7 @@ static struct dfs_fdtable _fdtab;
 static int  fd_alloc(struct dfs_fdtable *fdt, int startfd);
 
 /**
- * @addtogroup DFS
+ * @addtogroup group_DFS
  * @{
  */
 
@@ -297,7 +297,7 @@ static int fd_alloc(struct dfs_fdtable *fdt, int startfd)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  * 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 Fd
+ * @ingroup group_Fd
  *
  * This function will return a file descriptor structure according to file
  * descriptor.
@@ -373,7 +373,7 @@ struct dfs_file *fd_get(int fd)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  *
  * @brief This function will release the file descriptor.
  *
@@ -480,7 +480,7 @@ rt_err_t sys_dup(int oldfd)
 #endif /* DFS_USING_POSIX */
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  *
  * 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 FileApi
+ * @addtogroup group_FileApi
  * @{
  */
 

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 FsApi
+ * @addtogroup group_FsApi
  * @{
  */
 

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 FsPosixApi
+ * @addtogroup group_FsPosixApi
  * @{
  */
 

diff --git a/components/dfs/dfs_v2/src/dfs.c b/components/dfs/dfs_v2/src/dfs.c
@@ -139,7 +139,7 @@ void dfs_unlock(void)
     rt_mutex_release(&fslock);
 }
 
-/** @addtogroup DFS
+/** @addtogroup group_DFS
  *
  *
  *  @{
@@ -218,7 +218,7 @@ void dfs_file_destroy(struct dfs_file *file)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  * 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 Fd
+ * @ingroup group_Fd
  *
  * This function will return a file descriptor structure according to file
  * descriptor.
@@ -369,7 +369,7 @@ int fd_new(void)
 }
 
 /**
- * @ingroup Fd
+ * @ingroup group_Fd
  *
  * 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 FsApi
+ * @addtogroup group_FsApi
  */
 /*@{*/
 

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 FsPosixApi
+ * @addtogroup group_FsPosixApi
  * @{
  */
 

diff --git a/components/drivers/clk/clk.c b/components/drivers/clk/clk.c
@@ -14,11 +14,11 @@
 #include <rtdevice.h>
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    clk              clk
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_clk clk
  * @brief       clk driver api
- * @ingroup     Drivers
- * @addtogroup  clk
+ * @ingroup group_Drivers
+ * @addtogroup  group_clk
  * @{
  */
 

diff --git a/components/drivers/include/drivers/adc.h b/components/drivers/include/drivers/adc.h
@@ -15,8 +15,8 @@
 
 #include <rtthread.h>
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    ADC           ADC
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_ADC ADC
  *
  * @brief       ADC driver api
  *
@@ -57,12 +57,12 @@
  *
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 
 /*!
- * @addtogroup ADC
+ * @addtogroup group_ADC
  * @{
  */
 #define RT_ADC_INTERN_CH_TEMPER     (-1)
@@ -105,7 +105,7 @@ typedef enum
  * @param ops device ops
  * @param user_data device private data
  * @return rt_err_t        error code
- * @ingroup  ADC
+ * @ingroup group_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);
 
@@ -114,7 +114,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  ADC
+ * @ingroup group_ADC
  */
 rt_uint32_t rt_adc_read(rt_adc_device_t dev, rt_int8_t channel);
 
@@ -123,7 +123,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  ADC
+ * @ingroup group_ADC
  */
 rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);
 
@@ -132,7 +132,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  ADC
+ * @ingroup group_ADC
  */
 rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);
 
@@ -141,7 +141,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  ADC
+ * @ingroup group_ADC
  */
 rt_int16_t rt_adc_voltage(rt_adc_device_t dev, rt_int8_t channel);
 

diff --git a/components/drivers/include/drivers/blk.h b/components/drivers/include/drivers/blk.h
@@ -17,11 +17,11 @@
 #include <drivers/classes/block.h>
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    blk              blk
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_blk blk
  * @brief       blk driver api
- * @ingroup     Drivers
- * @addtogroup  blk
+ * @ingroup group_Drivers
+ * @addtogroup  group_blk
  * @{
  */
 

diff --git a/components/drivers/include/drivers/clk.h b/components/drivers/include/drivers/clk.h
@@ -18,11 +18,11 @@
 #include <drivers/ofw.h>
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    clk              clk
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_clk clk
  * @brief       clk driver api
- * @ingroup     Drivers
- * @addtogroup  clk
+ * @ingroup group_Drivers
+ * @addtogroup  group_clk
  * @{
  */
 

diff --git a/components/drivers/include/drivers/dac.h b/components/drivers/include/drivers/dac.h
@@ -12,8 +12,8 @@
 #define __DAC_H__
 #include <rtthread.h>
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    DAC           DAC
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_DAC DAC
  *
  * @brief       DAC driver api
  *
@@ -60,11 +60,11 @@
  *
  * @endcode
  *
- * @ingroup Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup DAC
+ * @addtogroup group_DAC
  * @{
  */
 struct rt_dac_device;

diff --git a/components/drivers/include/drivers/dev_can.h b/components/drivers/include/drivers/dev_can.h
@@ -64,8 +64,8 @@ enum CANBAUD
 #define RT_CAN_MODE_NOPRIV              0x00
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    CAN_Device          CAN Driver
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_CAN_Device CAN Driver
  *
  * @brief       CAN driver api
  *
@@ -199,13 +199,13 @@ enum CANBAUD
  * MSH_CMD_EXPORT(can_sample, can device sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  *
  */
 
 
 /*!
- * @addtogroup CAN_Device
+ * @addtogroup group_CAN_Device
  * @{
  */
 #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,8 +14,8 @@
 
 #include <rtthread.h>
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    I2C              I2C
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_I2C I2C
  *
  * @brief       I2C driver api
  *
@@ -169,11 +169,11 @@
  * MSH_CMD_EXPORT(i2c_aht10_sample, i2c aht10 sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup I2C
+ * @addtogroup group_I2C
  * @{
  */
 #ifdef __cplusplus

diff --git a/components/drivers/include/drivers/dev_pin.h b/components/drivers/include/drivers/dev_pin.h
@@ -15,8 +15,8 @@
 #include <rtthread.h>
 
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    Pin              Pin
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_Pin Pin
  *
  * @brief       Pin driver api
  *
@@ -68,11 +68,11 @@
  * MSH_CMD_EXPORT(pin_beep_sample, pin beep sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup Pin
+ * @addtogroup group_Pin
  * @{
  */
 #ifdef __cplusplus

diff --git a/components/drivers/include/drivers/dev_pwm.h b/components/drivers/include/drivers/dev_pwm.h
@@ -14,8 +14,8 @@
 
 #include <rtthread.h>
 /**
- * @addtogroup  Drivers          RTTHREAD Driver
- * @defgroup    PWM              PWM
+ * @addtogroup group_Drivers RTTHREAD Driver
+ * @defgroup group_PWM PWM
  *
  * @brief       PWM driver api
  *
@@ -78,11 +78,11 @@
  * MSH_CMD_EXPORT(pwm_led_sample, pwm sample);
  * @endcode
  *
- * @ingroup     Drivers
+ * @ingroup group_Drivers
  */
 
 /*!
- * @addtogroup PWM
+ * @addtogroup group_PWM
  * @{
  */
 #define PWM_CMD_ENABLE      (RT_DEVICE_CTRL_BASE(PWM) + 0)
-Original file line number
+Diff line change
@@ Expand Up @@
     }
     /**
-     * @addtogroup FileApi
+     * @addtogroup group_FileApi
      * @{
      */
@@ Expand Down @@