Doxygen: move device/driver under to components

components/drivers/clk/clk.c

@@ -14,10 +14,9 @@
 #include <rtdevice.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
  * @{
  */

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
  */
 
 

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
  * @{
  */

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
  * @{
  */

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
  */
 
 /*!

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
  *
  * @{
  */

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
- *
  */
 
 

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
  */
 
 /*!

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
  */
 
 /*!

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
  */
 
 /*!

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
  */
 
 /*!

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
  */
 
 

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
  */
 
 

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
  */
 
 /*!

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
  */
 
 /*!

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.
  *

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

documentation/5.device/INDEX.md → 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

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