RT-Thread
/
rt-thread
mirror of https://github.com/RT-Thread/rt-thread
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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

* doxygen: fs: unify groupname to lowercase

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>

* doxygen: drivers: unify groupname to lowercase

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>

* doxygen: signal: unify groupname to lowercase

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>

---------

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang 2025-07-22 13:59:25 +08:00 committed by GitHub
parent 0441065193
commit 2aebe694d9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
25 changed files with 57 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
components/dfs/dfs_v1/src/dfs.c
View File

@ -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 @@ exit:
#endif /* DFS_USING_POSIX */
/**
* @ingroup group_Fd
* @ingroup group_fs_file_descriptor
*
* This function will return whether this file has been opend.
*

2
components/dfs/dfs_v1/src/dfs_file.c
View File

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

2
components/dfs/dfs_v1/src/dfs_fs.c
View File

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

2
components/dfs/dfs_v1/src/dfs_posix.c
View File

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

6
components/dfs/dfs_v2/src/dfs.c
View File

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

2
components/dfs/dfs_v2/src/dfs_fs.c
View File

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

2
components/dfs/dfs_v2/src/dfs_posix.c
View File

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

4
components/drivers/audio/dev_audio.c
View File

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

14
components/drivers/include/drivers/adc.h
View File

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

4
components/drivers/include/drivers/dac.h
View File

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

4
components/drivers/include/drivers/dev_audio.h
View File

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

4
components/drivers/include/drivers/dev_can.h
View File

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

4
components/drivers/include/drivers/dev_i2c.h
View File

@ -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

4
components/drivers/include/drivers/dev_pin.h
View File

@ -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

4
components/drivers/include/drivers/dev_pwm.h
View File

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

4
components/drivers/include/drivers/dev_rtc.h
View File

@ -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

10
components/drivers/include/drivers/dev_serial.h
View File

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

10
components/drivers/include/drivers/dev_serial_v2.h
View File

@ -14,7 +14,7 @@
#include <rtthread.h>
#include <rtdevice.h>
/**
* @defgroup group_Serial_v2 Serial v2
* @defgroup group_drivers_serial_v2 Serial v2
* @brief Serial v2 driver api
* @ingroup group_device_driver
*
@ -121,7 +121,7 @@
/*!
* @addtogroup group_Serial_v2
* @addtogroup group_drivers_serial_v2
* @{
*/
@ -362,7 +362,7 @@ struct rt_uart_ops
* @brief Serial interrupt service routine
* @param serial serial device
* @param event event mask
* @ingroup group_Serial_v2
* @ingroup group_drivers_serial_v2
*/
void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
@ -378,7 +378,7 @@ rt_err_t rt_hw_serial_control_isr(struct rt_serial_device *serial, int cmd, void
* @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_v2
* @ingroup group_drivers_serial_v2
*/
rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
const char *name,
@ -391,7 +391,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_v2
* @ingroup group_drivers_serial_v2
*/
rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial);

4
components/drivers/include/drivers/dev_spi.h
View File

@ -19,7 +19,7 @@
#include <drivers/core/driver.h>
/**
* @defgroup group_SPI SPI
* @defgroup group_drivers_spi SPI
* @brief SPI driver api
* @ingroup group_device_driver
*
@ -86,7 +86,7 @@
*/
/*!
* @addtogroup group_SPI
* @addtogroup group_drivers_spi
* @{
*/
#ifdef __cplusplus

4
components/drivers/include/drivers/dev_touch.h
View File

@ -14,7 +14,7 @@
#include <rtthread.h>
#include "dev_pin.h"
/**
* @defgroup group_Touch Touch
* @defgroup group_drivers_touch Touch
* @brief Touch driver api
* @ingroup group_device_driver
*
@ -113,7 +113,7 @@
*/
/*!
* @addtogroup group_Touch
* @addtogroup group_drivers_touch
* @{
*/
#ifdef __cplusplus

8
documentation/0.doxygen/components/filesystem.h
View File

@ -8,20 +8,20 @@
*/
/**
* @defgroup group_Fd File Descriptor
* @defgroup group_fs_file_descriptor File Descriptor
*
*/
/**
* @defgroup group_FsApi File System API
* @defgroup group_fs_api File System API
*/
/**
* @defgroup group_FileApi File API
* @defgroup group_fs_file_api File API
*/
/**
* @defgroup group_FsPosixApi File POSIX API
* @defgroup group_fs_posix_api File POSIX API
*/
/**@}*/

2
documentation/0.doxygen/core/ipc.h
View File

@ -8,7 +8,7 @@
*/
/**
* @defgroup group_Signal Signal
* @defgroup group_signal Signal
* @brief signal is used for thread kill etc.
*
* A signal (also known as a soft interrupt signal), from a software perspective,

2
documentation/6.components/device-driver/audio/audio.md
View File

@ -6,7 +6,7 @@ The Audio device is a crucial component in embedded systems, responsible for aud
## API List
For more details, see @ref group_Audio
For more details, see @ref group_drivers_audio
## Audio Device Features

2
include/rtdef.h
View File

@ -578,7 +578,7 @@ typedef struct rt_timer *rt_timer_t;
/**@}*/
/**
* @addtogroup group_Signal
* @addtogroup group_signal
*/
/**@{*/

2
include/rtthread.h
View File

@ -248,7 +248,7 @@ void rt_scheduler_ipi_handler(int vector, void *param);
/**@}*/
/**
* @addtogroup group_Signal
* @addtogroup group_signal
* @{
*/
#ifdef RT_USING_SIGNALS