summaryrefslogtreecommitdiff
path: root/components/drivers/include
diff options
context:
space:
mode:
authorChen Wang <[email protected]>2025-05-29 09:44:02 +0800
committerRbb666 <[email protected]>2025-05-29 13:47:46 +0800
commita3339ca734adb30c4b1f598b1283560f010a21b5 (patch)
tree9d6bb92468cab1913ebe5fb83e52b56bddd327d3 /components/drivers/include
parente234cc865801940a78db8f5011845e336f22aeaf (diff)
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]>
Diffstat (limited to 'components/drivers/include')
-rw-r--r--components/drivers/include/drivers/adc.h8
-rw-r--r--components/drivers/include/drivers/blk.h5
-rw-r--r--components/drivers/include/drivers/clk.h5
-rw-r--r--components/drivers/include/drivers/dac.h7
-rw-r--r--components/drivers/include/drivers/dev_audio.h8
-rw-r--r--components/drivers/include/drivers/dev_can.h8
-rw-r--r--components/drivers/include/drivers/dev_i2c.h7
-rw-r--r--components/drivers/include/drivers/dev_pin.h7
-rw-r--r--components/drivers/include/drivers/dev_pwm.h7
-rw-r--r--components/drivers/include/drivers/dev_rtc.h7
-rw-r--r--components/drivers/include/drivers/dev_serial.h7
-rw-r--r--components/drivers/include/drivers/dev_serial_v2.h7
-rw-r--r--components/drivers/include/drivers/dev_spi.h7
-rw-r--r--components/drivers/include/drivers/dev_touch.h7
14 files changed, 30 insertions, 67 deletions
diff --git a/components/drivers/include/drivers/adc.h b/components/drivers/include/drivers/adc.h
index dfe64d4b9a..7449fad12d 100644
--- a/components/drivers/include/drivers/adc.h
+++ b/components/drivers/include/drivers/adc.h
@@ -15,10 +15,10 @@
#include <rtthread.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_ADC ADC
- *
+ * @defgroup group_ADC ADC
* @brief ADC driver api
+ * @ingroup group_device_driver
+ *
*
* <b>Example</b>
* @code {.c}
@@ -56,8 +56,6 @@
* MSH_CMD_EXPORT(adc_vol_sample, adc voltage convert sample);
*
* @endcode
- *
- * @ingroup group_Drivers
*/
diff --git a/components/drivers/include/drivers/blk.h b/components/drivers/include/drivers/blk.h
index 560e617bbe..95c1932456 100644
--- a/components/drivers/include/drivers/blk.h
+++ b/components/drivers/include/drivers/blk.h
@@ -17,10 +17,9 @@
#include <drivers/classes/block.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_blk blk
+ * @defgroup group_blk blk
* @brief blk driver api
- * @ingroup group_Drivers
+ * @ingroup group_device_driver
* @addtogroup group_blk
* @{
*/
diff --git a/components/drivers/include/drivers/clk.h b/components/drivers/include/drivers/clk.h
index fe508508d9..51e7a92431 100644
--- a/components/drivers/include/drivers/clk.h
+++ b/components/drivers/include/drivers/clk.h
@@ -18,10 +18,9 @@
#include <drivers/ofw.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_clk clk
+ * @defgroup group_clk clk
* @brief clk driver api
- * @ingroup group_Drivers
+ * @ingroup group_device_driver
* @addtogroup group_clk
* @{
*/
diff --git a/components/drivers/include/drivers/dac.h b/components/drivers/include/drivers/dac.h
index 6f5962c265..b1f6f96e69 100644
--- a/components/drivers/include/drivers/dac.h
+++ b/components/drivers/include/drivers/dac.h
@@ -12,10 +12,9 @@
#define __DAC_H__
#include <rtthread.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_DAC DAC
- *
+ * @defgroup group_DAC DAC
* @brief DAC driver api
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -59,8 +58,6 @@
* MSH_CMD_EXPORT(dac_vol_sample, dac voltage convert sample);
*
* @endcode
- *
- * @ingroup group_Drivers
*/
/*!
diff --git a/components/drivers/include/drivers/dev_audio.h b/components/drivers/include/drivers/dev_audio.h
index b79da83da0..44441dfcad 100644
--- a/components/drivers/include/drivers/dev_audio.h
+++ b/components/drivers/include/drivers/dev_audio.h
@@ -16,11 +16,9 @@
#include "dev_audio_pipe.h"
/**
- * @defgroup group_Audio Audio
- *
- * @ingroup group_Drivers RT-Thread Drivers
- *
- * @brief Audio driver API.
+ * @defgroup group_Audio Audio
+ * @brief Audio driver API.
+ * @ingroup group_device_driver
*
* @{
*/
diff --git a/components/drivers/include/drivers/dev_can.h b/components/drivers/include/drivers/dev_can.h
index c7e9a36140..169d172fd0 100644
--- a/components/drivers/include/drivers/dev_can.h
+++ b/components/drivers/include/drivers/dev_can.h
@@ -64,10 +64,9 @@ enum CANBAUD
#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
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -198,9 +197,6 @@ enum CANBAUD
* // 导出到 msh 命令列表中
* MSH_CMD_EXPORT(can_sample, can device sample);
* @endcode
- *
- * @ingroup group_Drivers
- *
*/
diff --git a/components/drivers/include/drivers/dev_i2c.h b/components/drivers/include/drivers/dev_i2c.h
index 9ca5ba6392..a3876a136b 100644
--- a/components/drivers/include/drivers/dev_i2c.h
+++ b/components/drivers/include/drivers/dev_i2c.h
@@ -14,10 +14,9 @@
#include <rtthread.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_I2C I2C
- *
+ * @defgroup group_I2C I2C
* @brief I2C driver api
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -168,8 +167,6 @@
* // 导出到 msh 命令列表中
* MSH_CMD_EXPORT(i2c_aht10_sample, i2c aht10 sample);
* @endcode
- *
- * @ingroup group_Drivers
*/
/*!
diff --git a/components/drivers/include/drivers/dev_pin.h b/components/drivers/include/drivers/dev_pin.h
index 64a811641d..5d19109f54 100644
--- a/components/drivers/include/drivers/dev_pin.h
+++ b/components/drivers/include/drivers/dev_pin.h
@@ -15,10 +15,9 @@
#include <rtthread.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_Pin Pin
- *
+ * @defgroup group_Pin Pin
* @brief Pin driver api
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -67,8 +66,6 @@
*
* MSH_CMD_EXPORT(pin_beep_sample, pin beep sample);
* @endcode
- *
- * @ingroup group_Drivers
*/
/*!
diff --git a/components/drivers/include/drivers/dev_pwm.h b/components/drivers/include/drivers/dev_pwm.h
index 8608eb8c70..4aa36cb261 100644
--- a/components/drivers/include/drivers/dev_pwm.h
+++ b/components/drivers/include/drivers/dev_pwm.h
@@ -14,10 +14,9 @@
#include <rtthread.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_PWM PWM
- *
+ * @defgroup group_PWM PWM
* @brief PWM driver api
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -77,8 +76,6 @@
*
* MSH_CMD_EXPORT(pwm_led_sample, pwm sample);
* @endcode
- *
- * @ingroup group_Drivers
*/
/*!
diff --git a/components/drivers/include/drivers/dev_rtc.h b/components/drivers/include/drivers/dev_rtc.h
index d8e53f14c2..f0e1be6ede 100644
--- a/components/drivers/include/drivers/dev_rtc.h
+++ b/components/drivers/include/drivers/dev_rtc.h
@@ -17,10 +17,9 @@
#include <rtdef.h>
#include <sys/time.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_RTC RTC
- *
+ * @defgroup group_RTC RTC
* @brief RTC driver api
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -72,8 +71,6 @@
* }
* MSH_CMD_EXPORT(rtc_sample, rtc sample);
* @endcode
- *
- * @ingroup group_Drivers
*/
/*!
diff --git a/components/drivers/include/drivers/dev_serial.h b/components/drivers/include/drivers/dev_serial.h
index 6fae356330..65c7ddd6c1 100644
--- a/components/drivers/include/drivers/dev_serial.h
+++ b/components/drivers/include/drivers/dev_serial.h
@@ -16,10 +16,9 @@
#include <rtthread.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_Serial Serial
- *
+ * @defgroup group_Serial Serial
* @brief Serial driver api
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -105,8 +104,6 @@
*
* MSH_CMD_EXPORT(uart_sample, uart device sample);
* @endcode
- *
- * @ingroup group_Drivers
*/
diff --git a/components/drivers/include/drivers/dev_serial_v2.h b/components/drivers/include/drivers/dev_serial_v2.h
index d1b116ab1c..94fadff27c 100644
--- a/components/drivers/include/drivers/dev_serial_v2.h
+++ b/components/drivers/include/drivers/dev_serial_v2.h
@@ -14,10 +14,9 @@
#include <rtthread.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
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -118,8 +117,6 @@
* }
* MSH_CMD_EXPORT(uart_dma_sample, uart device dma sample);
* @endcode
- *
- * @ingroup group_Drivers
*/
diff --git a/components/drivers/include/drivers/dev_spi.h b/components/drivers/include/drivers/dev_spi.h
index 23cbabf15c..c5de588d7c 100644
--- a/components/drivers/include/drivers/dev_spi.h
+++ b/components/drivers/include/drivers/dev_spi.h
@@ -19,10 +19,9 @@
#include <drivers/core/driver.h>
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_SPI SPI
- *
+ * @defgroup group_SPI SPI
* @brief SPI driver api
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -84,8 +83,6 @@
* // 导出到 msh 命令列表中
* MSH_CMD_EXPORT(spi_w25q_sample, spi w25q sample);
* @endcode
- *
- * @ingroup group_Drivers
*/
/*!
diff --git a/components/drivers/include/drivers/dev_touch.h b/components/drivers/include/drivers/dev_touch.h
index dd1a23f487..68e0591ab7 100644
--- a/components/drivers/include/drivers/dev_touch.h
+++ b/components/drivers/include/drivers/dev_touch.h
@@ -14,10 +14,9 @@
#include <rtthread.h>
#include "dev_pin.h"
/**
- * @addtogroup group_Drivers RTTHREAD Driver
- * @defgroup group_Touch Touch
- *
+ * @defgroup group_Touch Touch
* @brief Touch driver api
+ * @ingroup group_device_driver
*
* <b>Example</b>
* @code {.c}
@@ -111,8 +110,6 @@
* }
* MSH_CMD_EXPORT(gt9147_sample, gt9147 sample);
* @endcode
- *
- * @ingroup group_Drivers
*/
/*!