diff --git a/components/drivers/clk/clk.c b/components/drivers/clk/clk.c index e229dc16bca..7b059aea590 100644 --- a/components/drivers/clk/clk.c +++ b/components/drivers/clk/clk.c @@ -14,10 +14,9 @@ #include /** - * @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/adc.h b/components/drivers/include/drivers/adc.h index dfe64d4b9a3..7449fad12d2 100644 --- a/components/drivers/include/drivers/adc.h +++ b/components/drivers/include/drivers/adc.h @@ -15,10 +15,10 @@ #include /** - * @addtogroup group_Drivers RTTHREAD Driver - * @defgroup group_ADC ADC - * + * @defgroup group_ADC ADC * @brief ADC driver api + * @ingroup group_device_driver + * * * Example * @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 560e617bbec..95c1932456f 100644 --- a/components/drivers/include/drivers/blk.h +++ b/components/drivers/include/drivers/blk.h @@ -17,10 +17,9 @@ #include /** - * @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 fe508508d9e..51e7a92431a 100644 --- a/components/drivers/include/drivers/clk.h +++ b/components/drivers/include/drivers/clk.h @@ -18,10 +18,9 @@ #include /** - * @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 6f5962c265c..b1f6f96e694 100644 --- a/components/drivers/include/drivers/dac.h +++ b/components/drivers/include/drivers/dac.h @@ -12,10 +12,9 @@ #define __DAC_H__ #include /** - * @addtogroup group_Drivers RTTHREAD Driver - * @defgroup group_DAC DAC - * + * @defgroup group_DAC DAC * @brief DAC driver api + * @ingroup group_device_driver * * Example * @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 b79da83da06..44441dfcadd 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 c7e9a361402..169d172fd07 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 * * Example * @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 9ca5ba63928..a3876a136b0 100644 --- a/components/drivers/include/drivers/dev_i2c.h +++ b/components/drivers/include/drivers/dev_i2c.h @@ -14,10 +14,9 @@ #include /** - * @addtogroup group_Drivers RTTHREAD Driver - * @defgroup group_I2C I2C - * + * @defgroup group_I2C I2C * @brief I2C driver api + * @ingroup group_device_driver * * Example * @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 64a811641d5..5d19109f547 100644 --- a/components/drivers/include/drivers/dev_pin.h +++ b/components/drivers/include/drivers/dev_pin.h @@ -15,10 +15,9 @@ #include /** - * @addtogroup group_Drivers RTTHREAD Driver - * @defgroup group_Pin Pin - * + * @defgroup group_Pin Pin * @brief Pin driver api + * @ingroup group_device_driver * * Example * @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 8608eb8c70b..4aa36cb2618 100644 --- a/components/drivers/include/drivers/dev_pwm.h +++ b/components/drivers/include/drivers/dev_pwm.h @@ -14,10 +14,9 @@ #include /** - * @addtogroup group_Drivers RTTHREAD Driver - * @defgroup group_PWM PWM - * + * @defgroup group_PWM PWM * @brief PWM driver api + * @ingroup group_device_driver * * Example * @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 d8e53f14c21..f0e1be6ede7 100644 --- a/components/drivers/include/drivers/dev_rtc.h +++ b/components/drivers/include/drivers/dev_rtc.h @@ -17,10 +17,9 @@ #include #include /** - * @addtogroup group_Drivers RTTHREAD Driver - * @defgroup group_RTC RTC - * + * @defgroup group_RTC RTC * @brief RTC driver api + * @ingroup group_device_driver * * Example * @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 6fae3563300..65c7ddd6c12 100644 --- a/components/drivers/include/drivers/dev_serial.h +++ b/components/drivers/include/drivers/dev_serial.h @@ -16,10 +16,9 @@ #include /** - * @addtogroup group_Drivers RTTHREAD Driver - * @defgroup group_Serial Serial - * + * @defgroup group_Serial Serial * @brief Serial driver api + * @ingroup group_device_driver * * Example * @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 d1b116ab1c9..94fadff27cf 100644 --- a/components/drivers/include/drivers/dev_serial_v2.h +++ b/components/drivers/include/drivers/dev_serial_v2.h @@ -14,10 +14,9 @@ #include #include /** - * @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 * * Example * @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 23cbabf15ca..c5de588d7c4 100644 --- a/components/drivers/include/drivers/dev_spi.h +++ b/components/drivers/include/drivers/dev_spi.h @@ -19,10 +19,9 @@ #include /** - * @addtogroup group_Drivers RTTHREAD Driver - * @defgroup group_SPI SPI - * + * @defgroup group_SPI SPI * @brief SPI driver api + * @ingroup group_device_driver * * Example * @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 dd1a23f487c..68e0591ab73 100644 --- a/components/drivers/include/drivers/dev_touch.h +++ b/components/drivers/include/drivers/dev_touch.h @@ -14,10 +14,9 @@ #include #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 * * Example * @code {.c} @@ -111,8 +110,6 @@ * } * MSH_CMD_EXPORT(gt9147_sample, gt9147 sample); * @endcode - * - * @ingroup group_Drivers */ /*! diff --git a/documentation/0.doxygen/2.components.h b/documentation/0.doxygen/2.components.h index cc4fcff16e3..131fa3bf11a 100644 --- a/documentation/0.doxygen/2.components.h +++ b/documentation/0.doxygen/2.components.h @@ -1,6 +1,12 @@ /* * This file is only used for doxygen document generation. - */ + * + * Components + * - Device Virtual File System + * - Device Driver + * - Finsh Shell + * - Application Module + */ /** * @defgroup group_kernel_components Components @@ -31,7 +37,7 @@ */ /** - * @defgroup group_Device Device System + * @defgroup group_device_driver Device Driver * @brief device I/O subsystem * * The Device System is designed as simple and minimum layer to help communication between @@ -46,7 +52,7 @@ */ /** - * @defgroup group_finsh finsh shell + * @defgroup group_finsh Finsh Shell * * @brief finsh shell is a user command shell in RT-Thread RTOS. * diff --git a/documentation/6.components/INDEX.md b/documentation/6.components/INDEX.md index 1a7dc8c873d..d73a8907f9b 100644 --- a/documentation/6.components/INDEX.md +++ b/documentation/6.components/INDEX.md @@ -1,7 +1,8 @@ @page page_components Components -- @subpage page_component_finsh - @subpage page_component_vfs +- @subpage page_device +- @subpage page_component_finsh - @subpage page_component_utest - @subpage page_component_dlmodule - @subpage page_component_sal diff --git a/documentation/5.device/INDEX.md b/documentation/6.components/device-driver/INDEX.md similarity index 92% rename from documentation/5.device/INDEX.md rename to documentation/6.components/device-driver/INDEX.md index 6fa9e66d7c2..010d0fc9108 100644 --- a/documentation/5.device/INDEX.md +++ b/documentation/6.components/device-driver/INDEX.md @@ -1,4 +1,4 @@ -@page page_device Device +@page page_device Device Driver - @subpage page_device_framework - @subpage page_device_pin diff --git a/documentation/5.device/adc/adc.md b/documentation/6.components/device-driver/adc/adc.md similarity index 100% rename from documentation/5.device/adc/adc.md rename to documentation/6.components/device-driver/adc/adc.md diff --git a/documentation/5.device/adc/figures/adc-p.png b/documentation/6.components/device-driver/adc/figures/adc-p.png similarity index 100% rename from documentation/5.device/adc/figures/adc-p.png rename to documentation/6.components/device-driver/adc/figures/adc-p.png diff --git a/documentation/5.device/audio/audio.md b/documentation/6.components/device-driver/audio/audio.md similarity index 100% rename from documentation/5.device/audio/audio.md rename to documentation/6.components/device-driver/audio/audio.md diff --git a/documentation/5.device/framework/device.md b/documentation/6.components/device-driver/framework/device.md similarity index 100% rename from documentation/5.device/framework/device.md rename to documentation/6.components/device-driver/framework/device.md diff --git a/documentation/5.device/framework/figures/block-dev.png b/documentation/6.components/device-driver/framework/figures/block-dev.png similarity index 100% rename from documentation/5.device/framework/figures/block-dev.png rename to documentation/6.components/device-driver/framework/figures/block-dev.png diff --git a/documentation/5.device/framework/figures/io-call.png b/documentation/6.components/device-driver/framework/figures/io-call.png similarity index 100% rename from documentation/5.device/framework/figures/io-call.png rename to documentation/6.components/device-driver/framework/figures/io-call.png diff --git a/documentation/5.device/framework/figures/io-dev.png b/documentation/6.components/device-driver/framework/figures/io-dev.png similarity index 100% rename from documentation/5.device/framework/figures/io-dev.png rename to documentation/6.components/device-driver/framework/figures/io-dev.png diff --git a/documentation/5.device/framework/figures/io-fun-call.png b/documentation/6.components/device-driver/framework/figures/io-fun-call.png similarity index 100% rename from documentation/5.device/framework/figures/io-fun-call.png rename to documentation/6.components/device-driver/framework/figures/io-fun-call.png diff --git a/documentation/5.device/framework/figures/io-parent.png b/documentation/6.components/device-driver/framework/figures/io-parent.png similarity index 100% rename from documentation/5.device/framework/figures/io-parent.png rename to documentation/6.components/device-driver/framework/figures/io-parent.png diff --git a/documentation/5.device/framework/figures/wtd-uml.png b/documentation/6.components/device-driver/framework/figures/wtd-uml.png similarity index 100% rename from documentation/5.device/framework/figures/wtd-uml.png rename to documentation/6.components/device-driver/framework/figures/wtd-uml.png diff --git a/documentation/5.device/hwtimer/hwtimer.md b/documentation/6.components/device-driver/hwtimer/hwtimer.md similarity index 100% rename from documentation/5.device/hwtimer/hwtimer.md rename to documentation/6.components/device-driver/hwtimer/hwtimer.md diff --git a/documentation/5.device/i2c/figures/i2c1.png b/documentation/6.components/device-driver/i2c/figures/i2c1.png similarity index 100% rename from documentation/5.device/i2c/figures/i2c1.png rename to documentation/6.components/device-driver/i2c/figures/i2c1.png diff --git a/documentation/5.device/i2c/figures/i2c2.png b/documentation/6.components/device-driver/i2c/figures/i2c2.png similarity index 100% rename from documentation/5.device/i2c/figures/i2c2.png rename to documentation/6.components/device-driver/i2c/figures/i2c2.png diff --git a/documentation/5.device/i2c/figures/i2c3.png b/documentation/6.components/device-driver/i2c/figures/i2c3.png similarity index 100% rename from documentation/5.device/i2c/figures/i2c3.png rename to documentation/6.components/device-driver/i2c/figures/i2c3.png diff --git a/documentation/5.device/i2c/i2c.md b/documentation/6.components/device-driver/i2c/i2c.md similarity index 100% rename from documentation/5.device/i2c/i2c.md rename to documentation/6.components/device-driver/i2c/i2c.md diff --git a/documentation/5.device/pin/figures/pin2.png b/documentation/6.components/device-driver/pin/figures/pin2.png similarity index 100% rename from documentation/5.device/pin/figures/pin2.png rename to documentation/6.components/device-driver/pin/figures/pin2.png diff --git a/documentation/5.device/pin/pin.md b/documentation/6.components/device-driver/pin/pin.md similarity index 100% rename from documentation/5.device/pin/pin.md rename to documentation/6.components/device-driver/pin/pin.md diff --git a/documentation/5.device/pwm/figures/pwm-f.png b/documentation/6.components/device-driver/pwm/figures/pwm-f.png similarity index 100% rename from documentation/5.device/pwm/figures/pwm-f.png rename to documentation/6.components/device-driver/pwm/figures/pwm-f.png diff --git a/documentation/5.device/pwm/figures/pwm-l.png b/documentation/6.components/device-driver/pwm/figures/pwm-l.png similarity index 100% rename from documentation/5.device/pwm/figures/pwm-l.png rename to documentation/6.components/device-driver/pwm/figures/pwm-l.png diff --git a/documentation/5.device/pwm/pwm.md b/documentation/6.components/device-driver/pwm/pwm.md similarity index 100% rename from documentation/5.device/pwm/pwm.md rename to documentation/6.components/device-driver/pwm/pwm.md diff --git a/documentation/5.device/rtc/rtc.md b/documentation/6.components/device-driver/rtc/rtc.md similarity index 100% rename from documentation/5.device/rtc/rtc.md rename to documentation/6.components/device-driver/rtc/rtc.md diff --git a/documentation/5.device/sensor/sensor.md b/documentation/6.components/device-driver/sensor/sensor.md similarity index 100% rename from documentation/5.device/sensor/sensor.md rename to documentation/6.components/device-driver/sensor/sensor.md diff --git a/documentation/5.device/spi/figures/spi1.png b/documentation/6.components/device-driver/spi/figures/spi1.png similarity index 100% rename from documentation/5.device/spi/figures/spi1.png rename to documentation/6.components/device-driver/spi/figures/spi1.png diff --git a/documentation/5.device/spi/figures/spi2.png b/documentation/6.components/device-driver/spi/figures/spi2.png similarity index 100% rename from documentation/5.device/spi/figures/spi2.png rename to documentation/6.components/device-driver/spi/figures/spi2.png diff --git a/documentation/5.device/spi/figures/spi5.png b/documentation/6.components/device-driver/spi/figures/spi5.png similarity index 100% rename from documentation/5.device/spi/figures/spi5.png rename to documentation/6.components/device-driver/spi/figures/spi5.png diff --git a/documentation/5.device/spi/spi.md b/documentation/6.components/device-driver/spi/spi.md similarity index 100% rename from documentation/5.device/spi/spi.md rename to documentation/6.components/device-driver/spi/spi.md diff --git a/documentation/5.device/uart/figures/uart-dma.png b/documentation/6.components/device-driver/uart/figures/uart-dma.png similarity index 100% rename from documentation/5.device/uart/figures/uart-dma.png rename to documentation/6.components/device-driver/uart/figures/uart-dma.png diff --git a/documentation/5.device/uart/figures/uart-int.png b/documentation/6.components/device-driver/uart/figures/uart-int.png similarity index 100% rename from documentation/5.device/uart/figures/uart-int.png rename to documentation/6.components/device-driver/uart/figures/uart-int.png diff --git a/documentation/5.device/uart/figures/uart1.png b/documentation/6.components/device-driver/uart/figures/uart1.png similarity index 100% rename from documentation/5.device/uart/figures/uart1.png rename to documentation/6.components/device-driver/uart/figures/uart1.png diff --git a/documentation/5.device/uart/uart.md b/documentation/6.components/device-driver/uart/uart.md similarity index 100% rename from documentation/5.device/uart/uart.md rename to documentation/6.components/device-driver/uart/uart.md diff --git a/documentation/5.device/watchdog/watchdog.md b/documentation/6.components/device-driver/watchdog/watchdog.md similarity index 100% rename from documentation/5.device/watchdog/watchdog.md rename to documentation/6.components/device-driver/watchdog/watchdog.md diff --git a/documentation/5.device/wlan/figures/an0026_1.png b/documentation/6.components/device-driver/wlan/figures/an0026_1.png similarity index 100% rename from documentation/5.device/wlan/figures/an0026_1.png rename to documentation/6.components/device-driver/wlan/figures/an0026_1.png diff --git a/documentation/5.device/wlan/figures/an0026_3.png b/documentation/6.components/device-driver/wlan/figures/an0026_3.png similarity index 100% rename from documentation/5.device/wlan/figures/an0026_3.png rename to documentation/6.components/device-driver/wlan/figures/an0026_3.png diff --git a/documentation/5.device/wlan/figures/an0026_4.png b/documentation/6.components/device-driver/wlan/figures/an0026_4.png similarity index 100% rename from documentation/5.device/wlan/figures/an0026_4.png rename to documentation/6.components/device-driver/wlan/figures/an0026_4.png diff --git a/documentation/5.device/wlan/figures/an0026_5.png b/documentation/6.components/device-driver/wlan/figures/an0026_5.png similarity index 100% rename from documentation/5.device/wlan/figures/an0026_5.png rename to documentation/6.components/device-driver/wlan/figures/an0026_5.png diff --git a/documentation/5.device/wlan/wlan.md b/documentation/6.components/device-driver/wlan/wlan.md similarity index 100% rename from documentation/5.device/wlan/wlan.md rename to documentation/6.components/device-driver/wlan/wlan.md diff --git a/documentation/INDEX.md b/documentation/INDEX.md index 70f0d9c345a..d13bacfe2fe 100644 --- a/documentation/INDEX.md +++ b/documentation/INDEX.md @@ -6,47 +6,9 @@ @subpage page_kernel_core -- @ref page_kernel_basics -- @ref page_thread_management -- @ref page_clock_management -- @ref page_thread_sync -- @ref page_thread_comm -- @ref page_memory_management -- @ref page_interrupt_management -- @ref page_kernel_porting - -@subpage page_tool - -- @ref page_env -- @ref page_scons - -@subpage page_device - -- @ref page_device_framework -- @ref page_device_pin -- @ref page_device_uart -- @ref page_device_adc -- @ref page_device_i2c -- @ref page_device_spi -- @ref page_device_pwm -- @ref page_device_rtc -- @ref page_device_hwtimer -- @ref page_device_watchdog -- @ref page_device_wlan -- @ref page_device_sensor - @subpage page_components -- @ref page_component_finsh -- @ref page_component_vfs -- @ref page_component_utest -- @ref page_component_dlmodule -- @ref page_component_sal -- @ref page_component_at -- @ref page_component_posix -- @ref page_component_ulog -- @ref page_component_pm -- @ref page_component_network +@subpage page_tool @subpage page_code_contribution diff --git a/include/rtdef.h b/include/rtdef.h index 401a47be27c..068ee17a47a 100644 --- a/include/rtdef.h +++ b/include/rtdef.h @@ -1237,7 +1237,7 @@ typedef struct rt_mempool *rt_mp_t; #ifdef RT_USING_DEVICE /** - * @addtogroup group_Device + * @addtogroup group_device_driver */ /**@{*/ diff --git a/include/rtthread.h b/include/rtthread.h index 103e26e894e..aa7858d8cf4 100644 --- a/include/rtthread.h +++ b/include/rtthread.h @@ -663,7 +663,7 @@ void rt_spin_unlock_irqrestore(struct rt_spinlock *lock, rt_base_t level); #ifdef RT_USING_DEVICE /** - * @addtogroup group_Device + * @addtogroup group_device_driver * @{ */