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

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 <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang 2025-05-29 09:44:02 +08:00 committed by Rbb666
parent e234cc8658
commit a3339ca734
15 changed files with 32 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
components/drivers/clk/clk.c
View File

@ -14,10 +14,9 @@
#include <rtdevice.h> #include <rtdevice.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_clk clk
* @defgroup group_clk clk
* @brief clk driver api * @brief clk driver api
* @ingroup group_Drivers * @ingroup group_device_driver
* @addtogroup group_clk * @addtogroup group_clk
* @{ * @{
*/ */

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

@ -15,10 +15,10 @@
#include <rtthread.h> #include <rtthread.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_ADC ADC
* @defgroup group_ADC ADC
*
* @brief ADC driver api * @brief ADC driver api
* @ingroup group_device_driver
*
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -56,8 +56,6 @@
* MSH_CMD_EXPORT(adc_vol_sample, adc voltage convert sample); * MSH_CMD_EXPORT(adc_vol_sample, adc voltage convert sample);
* *
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */

5
components/drivers/include/drivers/blk.h
View File

@ -17,10 +17,9 @@
#include <drivers/classes/block.h> #include <drivers/classes/block.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_blk blk
* @defgroup group_blk blk
* @brief blk driver api * @brief blk driver api
* @ingroup group_Drivers * @ingroup group_device_driver
* @addtogroup group_blk * @addtogroup group_blk
* @{ * @{
*/ */

5
components/drivers/include/drivers/clk.h
View File

@ -18,10 +18,9 @@
#include <drivers/ofw.h> #include <drivers/ofw.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_clk clk
* @defgroup group_clk clk
* @brief clk driver api * @brief clk driver api
* @ingroup group_Drivers * @ingroup group_device_driver
* @addtogroup group_clk * @addtogroup group_clk
* @{ * @{
*/ */

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

@ -12,10 +12,9 @@
#define __DAC_H__ #define __DAC_H__
#include <rtthread.h> #include <rtthread.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_DAC DAC
* @defgroup group_DAC DAC
*
* @brief DAC driver api * @brief DAC driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -59,8 +58,6 @@
* MSH_CMD_EXPORT(dac_vol_sample, dac voltage convert sample); * MSH_CMD_EXPORT(dac_vol_sample, dac voltage convert sample);
* *
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */
/*! /*!

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

@ -16,11 +16,9 @@
#include "dev_audio_pipe.h" #include "dev_audio_pipe.h"
/** /**
* @defgroup group_Audio Audio * @defgroup group_Audio Audio
* * @brief Audio driver API.
* @ingroup group_Drivers RT-Thread Drivers * @ingroup group_device_driver
*
* @brief Audio driver API.
* *
* @{ * @{
*/ */

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

@ -64,10 +64,9 @@ enum CANBAUD
#define RT_CAN_MODE_NOPRIV 0x00 #define RT_CAN_MODE_NOPRIV 0x00
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_CAN_Device CAN Driver
* @defgroup group_CAN_Device CAN Driver
*
* @brief CAN driver api * @brief CAN driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -198,9 +197,6 @@ enum CANBAUD
* // 导出到 msh 命令列表中 * // 导出到 msh 命令列表中
* MSH_CMD_EXPORT(can_sample, can device sample); * MSH_CMD_EXPORT(can_sample, can device sample);
* @endcode * @endcode
*
* @ingroup group_Drivers
*
*/ */

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

@ -14,10 +14,9 @@
#include <rtthread.h> #include <rtthread.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_I2C I2C
* @defgroup group_I2C I2C
*
* @brief I2C driver api * @brief I2C driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -168,8 +167,6 @@
* // 导出到 msh 命令列表中 * // 导出到 msh 命令列表中
* MSH_CMD_EXPORT(i2c_aht10_sample, i2c aht10 sample); * MSH_CMD_EXPORT(i2c_aht10_sample, i2c aht10 sample);
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */
/*! /*!

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

@ -15,10 +15,9 @@
#include <rtthread.h> #include <rtthread.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_Pin Pin
* @defgroup group_Pin Pin
*
* @brief Pin driver api * @brief Pin driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -67,8 +66,6 @@
* *
* MSH_CMD_EXPORT(pin_beep_sample, pin beep sample); * MSH_CMD_EXPORT(pin_beep_sample, pin beep sample);
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */
/*! /*!

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

@ -14,10 +14,9 @@
#include <rtthread.h> #include <rtthread.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_PWM PWM
* @defgroup group_PWM PWM
*
* @brief PWM driver api * @brief PWM driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -77,8 +76,6 @@
* *
* MSH_CMD_EXPORT(pwm_led_sample, pwm sample); * MSH_CMD_EXPORT(pwm_led_sample, pwm sample);
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */
/*! /*!

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

@ -17,10 +17,9 @@
#include <rtdef.h> #include <rtdef.h>
#include <sys/time.h> #include <sys/time.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_RTC RTC
* @defgroup group_RTC RTC
*
* @brief RTC driver api * @brief RTC driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -72,8 +71,6 @@
* } * }
* MSH_CMD_EXPORT(rtc_sample, rtc sample); * MSH_CMD_EXPORT(rtc_sample, rtc sample);
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */
/*! /*!

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

@ -16,10 +16,9 @@
#include <rtthread.h> #include <rtthread.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_Serial Serial
* @defgroup group_Serial Serial
*
* @brief Serial driver api * @brief Serial driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -105,8 +104,6 @@
* *
* MSH_CMD_EXPORT(uart_sample, uart device sample); * MSH_CMD_EXPORT(uart_sample, uart device sample);
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */

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

@ -14,10 +14,9 @@
#include <rtthread.h> #include <rtthread.h>
#include <rtdevice.h> #include <rtdevice.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_Serial_v2 Serial v2
* @defgroup group_Serial_v2 Serial v2
*
* @brief Serial v2 driver api * @brief Serial v2 driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -118,8 +117,6 @@
* } * }
* MSH_CMD_EXPORT(uart_dma_sample, uart device dma sample); * MSH_CMD_EXPORT(uart_dma_sample, uart device dma sample);
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */

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

@ -19,10 +19,9 @@
#include <drivers/core/driver.h> #include <drivers/core/driver.h>
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_SPI SPI
* @defgroup group_SPI SPI
*
* @brief SPI driver api * @brief SPI driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -84,8 +83,6 @@
* // 导出到 msh 命令列表中 * // 导出到 msh 命令列表中
* MSH_CMD_EXPORT(spi_w25q_sample, spi w25q sample); * MSH_CMD_EXPORT(spi_w25q_sample, spi w25q sample);
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */
/*! /*!

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

@ -14,10 +14,9 @@
#include <rtthread.h> #include <rtthread.h>
#include "dev_pin.h" #include "dev_pin.h"
/** /**
* @addtogroup group_Drivers RTTHREAD Driver * @defgroup group_Touch Touch
* @defgroup group_Touch Touch
*
* @brief Touch driver api * @brief Touch driver api
* @ingroup group_device_driver
* *
* <b>Example</b> * <b>Example</b>
* @code {.c} * @code {.c}
@ -111,8 +110,6 @@
* } * }
* MSH_CMD_EXPORT(gt9147_sample, gt9147 sample); * MSH_CMD_EXPORT(gt9147_sample, gt9147 sample);
* @endcode * @endcode
*
* @ingroup group_Drivers
*/ */
/*! /*!