Skip to content

Commit a3339ca

Browse files
unicornxRbb666
authored andcommitted
doxygen: change group_Drivers to group_device_driver
The originally defined "group_Drivers" should actually be part of the device-driver component, so "group_Drivers" is renamed to "group_device_driver". In this way, the original "group_Device" and "group_Drivers" are merged into "group_device_driver". Adjusted the writing method of doxygen comments in the driver code to be unified as follows: ```c * @defgroup group_XXX XXX * @brief xxxxxx * @InGroup group_device_driver ``` Signed-off-by: Chen Wang <[email protected]>
1 parent e234cc8 commit a3339ca

File tree

15 files changed

+32
-70
lines changed

15 files changed

+32
-70
lines changed

components/drivers/clk/clk.c

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@
1414
#include <rtdevice.h>
1515

1616
/**
17-
* @addtogroup group_Drivers RTTHREAD Driver
18-
* @defgroup group_clk clk
17+
* @defgroup group_clk clk
1918
* @brief clk driver api
20-
* @ingroup group_Drivers
19+
* @ingroup group_device_driver
2120
* @addtogroup group_clk
2221
* @{
2322
*/

components/drivers/include/drivers/adc.h

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

1616
#include <rtthread.h>
1717
/**
18-
* @addtogroup group_Drivers RTTHREAD Driver
19-
* @defgroup group_ADC ADC
20-
*
18+
* @defgroup group_ADC ADC
2119
* @brief ADC driver api
20+
* @ingroup group_device_driver
21+
*
2222
*
2323
* <b>Example</b>
2424
* @code {.c}
@@ -56,8 +56,6 @@
5656
* MSH_CMD_EXPORT(adc_vol_sample, adc voltage convert sample);
5757
*
5858
* @endcode
59-
*
60-
* @ingroup group_Drivers
6159
*/
6260

6361

components/drivers/include/drivers/blk.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,9 @@
1717
#include <drivers/classes/block.h>
1818

1919
/**
20-
* @addtogroup group_Drivers RTTHREAD Driver
21-
* @defgroup group_blk blk
20+
* @defgroup group_blk blk
2221
* @brief blk driver api
23-
* @ingroup group_Drivers
22+
* @ingroup group_device_driver
2423
* @addtogroup group_blk
2524
* @{
2625
*/

components/drivers/include/drivers/clk.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,9 @@
1818
#include <drivers/ofw.h>
1919

2020
/**
21-
* @addtogroup group_Drivers RTTHREAD Driver
22-
* @defgroup group_clk clk
21+
* @defgroup group_clk clk
2322
* @brief clk driver api
24-
* @ingroup group_Drivers
23+
* @ingroup group_device_driver
2524
* @addtogroup group_clk
2625
* @{
2726
*/

components/drivers/include/drivers/dac.h

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@
1212
#define __DAC_H__
1313
#include <rtthread.h>
1414
/**
15-
* @addtogroup group_Drivers RTTHREAD Driver
16-
* @defgroup group_DAC DAC
17-
*
15+
* @defgroup group_DAC DAC
1816
* @brief DAC driver api
17+
* @ingroup group_device_driver
1918
*
2019
* <b>Example</b>
2120
* @code {.c}
@@ -59,8 +58,6 @@
5958
* MSH_CMD_EXPORT(dac_vol_sample, dac voltage convert sample);
6059
*
6160
* @endcode
62-
*
63-
* @ingroup group_Drivers
6461
*/
6562

6663
/*!

components/drivers/include/drivers/dev_audio.h

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

1818
/**
19-
* @defgroup group_Audio Audio
20-
*
21-
* @ingroup group_Drivers RT-Thread Drivers
22-
*
23-
* @brief Audio driver API.
19+
* @defgroup group_Audio Audio
20+
* @brief Audio driver API.
21+
* @ingroup group_device_driver
2422
*
2523
* @{
2624
*/

components/drivers/include/drivers/dev_can.h

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

6666
/**
67-
* @addtogroup group_Drivers RTTHREAD Driver
68-
* @defgroup group_CAN_Device CAN Driver
69-
*
67+
* @defgroup group_CAN_Device CAN Driver
7068
* @brief CAN driver api
69+
* @ingroup group_device_driver
7170
*
7271
* <b>Example</b>
7372
* @code {.c}
@@ -198,9 +197,6 @@ enum CANBAUD
198197
* // 导出到 msh 命令列表中
199198
* MSH_CMD_EXPORT(can_sample, can device sample);
200199
* @endcode
201-
*
202-
* @ingroup group_Drivers
203-
*
204200
*/
205201

206202

components/drivers/include/drivers/dev_i2c.h

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

1515
#include <rtthread.h>
1616
/**
17-
* @addtogroup group_Drivers RTTHREAD Driver
18-
* @defgroup group_I2C I2C
19-
*
17+
* @defgroup group_I2C I2C
2018
* @brief I2C driver api
19+
* @ingroup group_device_driver
2120
*
2221
* <b>Example</b>
2322
* @code {.c}
@@ -168,8 +167,6 @@
168167
* // 导出到 msh 命令列表中
169168
* MSH_CMD_EXPORT(i2c_aht10_sample, i2c aht10 sample);
170169
* @endcode
171-
*
172-
* @ingroup group_Drivers
173170
*/
174171

175172
/*!

components/drivers/include/drivers/dev_pin.h

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

1717
/**
18-
* @addtogroup group_Drivers RTTHREAD Driver
19-
* @defgroup group_Pin Pin
20-
*
18+
* @defgroup group_Pin Pin
2119
* @brief Pin driver api
20+
* @ingroup group_device_driver
2221
*
2322
* <b>Example</b>
2423
* @code {.c}
@@ -67,8 +66,6 @@
6766
*
6867
* MSH_CMD_EXPORT(pin_beep_sample, pin beep sample);
6968
* @endcode
70-
*
71-
* @ingroup group_Drivers
7269
*/
7370

7471
/*!

components/drivers/include/drivers/dev_pwm.h

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

1515
#include <rtthread.h>
1616
/**
17-
* @addtogroup group_Drivers RTTHREAD Driver
18-
* @defgroup group_PWM PWM
19-
*
17+
* @defgroup group_PWM PWM
2018
* @brief PWM driver api
19+
* @ingroup group_device_driver
2120
*
2221
* <b>Example</b>
2322
* @code {.c}
@@ -77,8 +76,6 @@
7776
*
7877
* MSH_CMD_EXPORT(pwm_led_sample, pwm sample);
7978
* @endcode
80-
*
81-
* @ingroup group_Drivers
8279
*/
8380

8481
/*!

components/drivers/include/drivers/dev_rtc.h

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,9 @@
1717
#include <rtdef.h>
1818
#include <sys/time.h>
1919
/**
20-
* @addtogroup group_Drivers RTTHREAD Driver
21-
* @defgroup group_RTC RTC
22-
*
20+
* @defgroup group_RTC RTC
2321
* @brief RTC driver api
22+
* @ingroup group_device_driver
2423
*
2524
* <b>Example</b>
2625
* @code {.c}
@@ -72,8 +71,6 @@
7271
* }
7372
* MSH_CMD_EXPORT(rtc_sample, rtc sample);
7473
* @endcode
75-
*
76-
* @ingroup group_Drivers
7774
*/
7875

7976
/*!

components/drivers/include/drivers/dev_serial.h

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

1717
#include <rtthread.h>
1818
/**
19-
* @addtogroup group_Drivers RTTHREAD Driver
20-
* @defgroup group_Serial Serial
21-
*
19+
* @defgroup group_Serial Serial
2220
* @brief Serial driver api
21+
* @ingroup group_device_driver
2322
*
2423
* <b>Example</b>
2524
* @code {.c}
@@ -105,8 +104,6 @@
105104
*
106105
* MSH_CMD_EXPORT(uart_sample, uart device sample);
107106
* @endcode
108-
*
109-
* @ingroup group_Drivers
110107
*/
111108

112109

components/drivers/include/drivers/dev_serial_v2.h

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@
1414
#include <rtthread.h>
1515
#include <rtdevice.h>
1616
/**
17-
* @addtogroup group_Drivers RTTHREAD Driver
18-
* @defgroup group_Serial_v2 Serial v2
19-
*
17+
* @defgroup group_Serial_v2 Serial v2
2018
* @brief Serial v2 driver api
19+
* @ingroup group_device_driver
2120
*
2221
* <b>Example</b>
2322
* @code {.c}
@@ -118,8 +117,6 @@
118117
* }
119118
* MSH_CMD_EXPORT(uart_dma_sample, uart device dma sample);
120119
* @endcode
121-
*
122-
* @ingroup group_Drivers
123120
*/
124121

125122

components/drivers/include/drivers/dev_spi.h

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,9 @@
1919
#include <drivers/core/driver.h>
2020

2121
/**
22-
* @addtogroup group_Drivers RTTHREAD Driver
23-
* @defgroup group_SPI SPI
24-
*
22+
* @defgroup group_SPI SPI
2523
* @brief SPI driver api
24+
* @ingroup group_device_driver
2625
*
2726
* <b>Example</b>
2827
* @code {.c}
@@ -84,8 +83,6 @@
8483
* // 导出到 msh 命令列表中
8584
* MSH_CMD_EXPORT(spi_w25q_sample, spi w25q sample);
8685
* @endcode
87-
*
88-
* @ingroup group_Drivers
8986
*/
9087

9188
/*!

components/drivers/include/drivers/dev_touch.h

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@
1414
#include <rtthread.h>
1515
#include "dev_pin.h"
1616
/**
17-
* @addtogroup group_Drivers RTTHREAD Driver
18-
* @defgroup group_Touch Touch
19-
*
17+
* @defgroup group_Touch Touch
2018
* @brief Touch driver api
19+
* @ingroup group_device_driver
2120
*
2221
* <b>Example</b>
2322
* @code {.c}
@@ -111,8 +110,6 @@
111110
* }
112111
* MSH_CMD_EXPORT(gt9147_sample, gt9147 sample);
113112
* @endcode
114-
*
115-
* @ingroup group_Drivers
116113
*/
117114

118115
/*!

0 commit comments

Comments
 (0)