Skip to content

Commit 200a85f

Browse files
committed
doxygen: drivers: unify groupname to lowercase
Signed-off-by: Chen Wang <[email protected]>
1 parent 185147b commit 200a85f

File tree

14 files changed

+38
-38
lines changed

14 files changed

+38
-38
lines changed

components/drivers/audio/dev_audio.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
#endif
2525

2626
/**
27-
* @addtogroup group_Audio
27+
* @addtogroup group_drivers_audio
2828
*/
2929

3030
/** @{ */
@@ -781,4 +781,4 @@ void rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt_size_t
781781
audio->parent.rx_indicate(&audio->parent, len);
782782
}
783783

784-
/** @} group_Audio */
784+
/** @} group_drivers_audio */

components/drivers/include/drivers/adc.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
#include <rtthread.h>
1717
/**
18-
* @defgroup group_ADC ADC
18+
* @defgroup group_drivers_adc ADC
1919
* @brief ADC driver api
2020
* @ingroup group_device_driver
2121
*
@@ -60,7 +60,7 @@
6060

6161

6262
/*!
63-
* @addtogroup group_ADC
63+
* @addtogroup group_drivers_adc
6464
* @{
6565
*/
6666
#define RT_ADC_INTERN_CH_TEMPER (-1)
@@ -103,7 +103,7 @@ typedef enum
103103
* @param ops device ops
104104
* @param user_data device private data
105105
* @return rt_err_t error code
106-
* @ingroup group_ADC
106+
* @ingroup group_drivers_adc
107107
*/
108108
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);
109109

@@ -112,7 +112,7 @@ rt_err_t rt_hw_adc_register(rt_adc_device_t adc,const char *name, const struct r
112112
* @param dev adc device
113113
* @param channel adc channel
114114
* @return rt_uint32_t adc value
115-
* @ingroup group_ADC
115+
* @ingroup group_drivers_adc
116116
*/
117117
rt_uint32_t rt_adc_read(rt_adc_device_t dev, rt_int8_t channel);
118118

@@ -121,7 +121,7 @@ rt_uint32_t rt_adc_read(rt_adc_device_t dev, rt_int8_t channel);
121121
* @param dev adc device
122122
* @param channel adc channel
123123
* @return rt_err_t error code
124-
* @ingroup group_ADC
124+
* @ingroup group_drivers_adc
125125
*/
126126
rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);
127127

@@ -130,7 +130,7 @@ rt_err_t rt_adc_enable(rt_adc_device_t dev, rt_int8_t channel);
130130
* @param dev adc device
131131
* @param channel adc channel
132132
* @return rt_err_t error code
133-
* @ingroup group_ADC
133+
* @ingroup group_drivers_adc
134134
*/
135135
rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);
136136

@@ -139,7 +139,7 @@ rt_err_t rt_adc_disable(rt_adc_device_t dev, rt_int8_t channel);
139139
* @param dev adc device
140140
* @param channel adc channel
141141
* @return rt_int16_t adc resolution
142-
* @ingroup group_ADC
142+
* @ingroup group_drivers_adc
143143
*/
144144
rt_int16_t rt_adc_voltage(rt_adc_device_t dev, rt_int8_t channel);
145145

components/drivers/include/drivers/dac.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
#define __DAC_H__
1313
#include <rtthread.h>
1414
/**
15-
* @defgroup group_DAC DAC
15+
* @defgroup group_drivers_dac DAC
1616
* @brief DAC driver api
1717
* @ingroup group_device_driver
1818
*
@@ -61,7 +61,7 @@
6161
*/
6262

6363
/*!
64-
* @addtogroup group_DAC
64+
* @addtogroup group_drivers_dac
6565
* @{
6666
*/
6767
struct rt_dac_device;

components/drivers/include/drivers/dev_audio.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
#include "dev_audio_pipe.h"
1717

1818
/**
19-
* @defgroup group_Audio Audio
19+
* @defgroup group_drivers_audio Audio
2020
* @brief Audio driver API.
2121
* @ingroup group_device_driver
2222
*
@@ -286,6 +286,6 @@ void rt_audio_rx_done(struct rt_audio_device *audio, rt_uint8_t *pbuf, rt
286286
#define CODEC_VOLUME_MAX (63)
287287
/** @} */ /* End of group_audio_codec_cmd */
288288

289-
/** @} group_Audio */
289+
/** @} group_drivers_audio */
290290

291291
#endif /* __DEV_AUDIO_H__ */

components/drivers/include/drivers/dev_can.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ enum CANBAUD
6464
#define RT_CAN_MODE_NOPRIV 0x00
6565

6666
/**
67-
* @defgroup group_CAN_Device CAN Driver
67+
* @defgroup group_drivers_can CAN Driver
6868
* @brief CAN driver api
6969
* @ingroup group_device_driver
7070
*
@@ -201,7 +201,7 @@ enum CANBAUD
201201

202202

203203
/*!
204-
* @addtogroup group_CAN_Device
204+
* @addtogroup group_drivers_can
205205
* @{
206206
*/
207207
#define CAN_RX_FIFO0 (0x00000000U) /*!< CAN receive FIFO 0 */

components/drivers/include/drivers/dev_i2c.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
#include <rtthread.h>
1616
/**
17-
* @defgroup group_I2C I2C
17+
* @defgroup group_drivers_i2c I2C
1818
* @brief I2C driver api
1919
* @ingroup group_device_driver
2020
*
@@ -170,7 +170,7 @@
170170
*/
171171

172172
/*!
173-
* @addtogroup group_I2C
173+
* @addtogroup group_drivers_i2c
174174
* @{
175175
*/
176176
#ifdef __cplusplus

components/drivers/include/drivers/dev_pin.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
#include <rtthread.h>
1616

1717
/**
18-
* @defgroup group_Pin Pin
18+
* @defgroup group_drivers_pin Pin
1919
* @brief Pin driver api
2020
* @ingroup group_device_driver
2121
*
@@ -69,7 +69,7 @@
6969
*/
7070

7171
/*!
72-
* @addtogroup group_Pin
72+
* @addtogroup group_drivers_pin
7373
* @{
7474
*/
7575
#ifdef __cplusplus

components/drivers/include/drivers/dev_pwm.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
#include <rtthread.h>
1616
/**
17-
* @defgroup group_PWM PWM
17+
* @defgroup group_drivers_pwm PWM
1818
* @brief PWM driver api
1919
* @ingroup group_device_driver
2020
*
@@ -79,7 +79,7 @@
7979
*/
8080

8181
/*!
82-
* @addtogroup group_PWM
82+
* @addtogroup group_drivers_pwm
8383
* @{
8484
*/
8585
#define PWM_CMD_ENABLE (RT_DEVICE_CTRL_BASE(PWM) + 0)

components/drivers/include/drivers/dev_rtc.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
#include <rtdef.h>
1818
#include <sys/time.h>
1919
/**
20-
* @defgroup group_RTC RTC
20+
* @defgroup group_drivers_rtc RTC
2121
* @brief RTC driver api
2222
* @ingroup group_device_driver
2323
*
@@ -74,7 +74,7 @@
7474
*/
7575

7676
/*!
77-
* @addtogroup group_RTC
77+
* @addtogroup group_drivers_rtc
7878
* @{
7979
*/
8080
#ifdef __cplusplus

components/drivers/include/drivers/dev_serial.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
#include <rtthread.h>
1818
/**
19-
* @defgroup group_Serial Serial
19+
* @defgroup group_drivers_serial Serial
2020
* @brief Serial driver api
2121
* @ingroup group_device_driver
2222
*
@@ -108,7 +108,7 @@
108108

109109

110110
/*!
111-
* @addtogroup group_Serial
111+
* @addtogroup group_drivers_serial
112112
* @{
113113
*/
114114
#define BAUD_RATE_2400 2400
@@ -286,7 +286,7 @@ struct rt_uart_ops
286286
* @brief Serial interrupt service routine
287287
* @param serial serial device
288288
* @param event event mask
289-
* @ingroup group_Serial
289+
* @ingroup group_drivers_serial
290290
*/
291291
void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
292292

@@ -300,7 +300,7 @@ void rt_hw_serial_isr(struct rt_serial_device *serial, int event);
300300
* @return rt_err_t error code
301301
* @note This function will register a serial device to system device list,
302302
* and add a device object to system object list.
303-
* @ingroup group_Serial
303+
* @ingroup group_drivers_serial
304304
*/
305305
rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
306306
const char *name,
@@ -313,7 +313,7 @@ rt_err_t rt_hw_serial_register(struct rt_serial_device *serial,
313313
* @param serial serial device
314314
* @return rt_err_t error code
315315
*
316-
* @ingroup group_Serial
316+
* @ingroup group_drivers_serial
317317
*/
318318
rt_err_t rt_hw_serial_register_tty(struct rt_serial_device *serial);
319319

0 commit comments

Comments
 (0)