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 <[email protected]>

* 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 <[email protected]>

---------

Signed-off-by: Chen Wang <[email protected]>

Author: unicornx

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.
  *

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
  * @{
  */
 

components/dfs/dfs_v1/src/dfs_fs.c

@@ -17,7 +17,7 @@
 #include "dfs_private.h"
 
 /**
- * @addtogroup FsApi
+ * @addtogroup group_FsApi
  * @{
  */
 

components/dfs/dfs_v1/src/dfs_posix.c

@@ -19,7 +19,7 @@
 #endif
 
 /**
- * @addtogroup FsPosixApi
+ * @addtogroup group_FsPosixApi
  * @{
  */
 

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.
  */

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
  */
 /*@{*/
 

components/dfs/dfs_v2/src/dfs_posix.c

@@ -22,7 +22,7 @@
 #endif
 
 /**
- * @addtogroup FsPosixApi
+ * @addtogroup group_FsPosixApi
  * @{
  */
 

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
  * @{
  */
 

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);
 

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
  * @{
  */