Skip to content

doxygen: add prefix for groups #9991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
supperthomas merged 2 commits into from
Feb 15, 2025
Merged

doxygen: add prefix for groups #9991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0bbb9d
doxygen: add prefix for groups
unicornx Feb 14, 2025
208c8d9
ci: fixed error report when run file_check.py
unicornx Feb 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions components/dfs/dfs_v1/src/dfs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ static struct dfs_fdtable _fdtab;
static int fd_alloc(struct dfs_fdtable *fdt, int startfd);

/**
* @addtogroup DFS
* @addtogroup group_DFS
* @{
*/

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -373,7 +373,7 @@ struct dfs_file *fd_get(int fd)
}

/**
* @ingroup Fd
* @ingroup group_Fd
*
* @brief This function will release the file descriptor.
*
Expand Down Expand Up @@ -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.
*
Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v1/src/dfs_file.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ static struct dfs_vnode *dfs_vnode_find(const char *path, rt_list_t **hash_head)
}

/**
* @addtogroup FileApi
* @addtogroup group_FileApi
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v1/src/dfs_fs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#include "dfs_private.h"

/**
* @addtogroup FsApi
* @addtogroup group_FsApi
* @{
*/

Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v1/src/dfs_posix.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#endif

/**
* @addtogroup FsPosixApi
* @addtogroup group_FsPosixApi
* @{
*/

Expand Down
8 changes: 4 additions & 4 deletions components/dfs/dfs_v2/src/dfs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ void dfs_unlock(void)
rt_mutex_release(&fslock);
}

/** @addtogroup DFS
/** @addtogroup group_DFS
*
*
* @{
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -369,7 +369,7 @@ int fd_new(void)
}

/**
* @ingroup Fd
* @ingroup group_Fd
*
* This function will put the file descriptor.
*/
Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v2/src/dfs_fs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ static struct dfs_filesystem_type *file_systems = NULL;
extern rt_list_t _mnt_list;

/**
* @addtogroup FsApi
* @addtogroup group_FsApi
*/
/*@{*/

Expand Down
2 changes: 1 addition & 1 deletion components/dfs/dfs_v2/src/dfs_posix.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
#endif

/**
* @addtogroup FsPosixApi
* @addtogroup group_FsPosixApi
* @{
*/

Expand Down
8 changes: 4 additions & 4 deletions components/drivers/clk/clk.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/

Expand Down
18 changes: 9 additions & 9 deletions components/drivers/include/drivers/adc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -57,12 +57,12 @@
*
* @endcode
*
* @ingroup Drivers
* @ingroup group_Drivers
*/


/*!
* @addtogroup ADC
* @addtogroup group_ADC
* @{
*/
#define RT_ADC_INTERN_CH_TEMPER (-1)
Expand Down Expand Up @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand All @@ -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);

Expand Down
8 changes: 4 additions & 4 deletions components/drivers/include/drivers/blk.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/

Expand Down
8 changes: 4 additions & 4 deletions components/drivers/include/drivers/clk.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
* @{
*/

Expand Down
8 changes: 4 additions & 4 deletions components/drivers/include/drivers/dac.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -60,11 +60,11 @@
*
* @endcode
*
* @ingroup Drivers
* @ingroup group_Drivers
*/

/*!
* @addtogroup DAC
* @addtogroup group_DAC
* @{
*/
struct rt_dac_device;
Expand Down
8 changes: 4 additions & 4 deletions components/drivers/include/drivers/dev_can.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -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 */
Expand Down
8 changes: 4 additions & 4 deletions components/drivers/include/drivers/dev_i2c.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions components/drivers/include/drivers/dev_pin.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions components/drivers/include/drivers/dev_pwm.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down Expand Up @@ -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)
Expand Down
Loading
Loading