Browse Source

doxygen: move device_driver under to components for pages

In line with the layout of the source code, the
Device-Driver submodule should belong to components.

The doxygen Module part has been adjusted. This commit
modifies the markdown document part and moves the
device-driver pages under to components.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
Chen Wang 4 weeks ago
parent
commit
52acf7a413
39 changed files with 4 additions and 41 deletions
  1. 2 1
      documentation/6.components/INDEX.md
  2. 1 1
      documentation/6.components/device-driver/INDEX.md
  3. 0 0
      documentation/6.components/device-driver/adc/adc.md
  4. 0 0
      documentation/6.components/device-driver/adc/figures/adc-p.png
  5. 0 0
      documentation/6.components/device-driver/audio/audio.md
  6. 0 0
      documentation/6.components/device-driver/framework/device.md
  7. 0 0
      documentation/6.components/device-driver/framework/figures/block-dev.png
  8. 0 0
      documentation/6.components/device-driver/framework/figures/io-call.png
  9. 0 0
      documentation/6.components/device-driver/framework/figures/io-dev.png
  10. 0 0
      documentation/6.components/device-driver/framework/figures/io-fun-call.png
  11. 0 0
      documentation/6.components/device-driver/framework/figures/io-parent.png
  12. 0 0
      documentation/6.components/device-driver/framework/figures/wtd-uml.png
  13. 0 0
      documentation/6.components/device-driver/hwtimer/hwtimer.md
  14. 0 0
      documentation/6.components/device-driver/i2c/figures/i2c1.png
  15. 0 0
      documentation/6.components/device-driver/i2c/figures/i2c2.png
  16. 0 0
      documentation/6.components/device-driver/i2c/figures/i2c3.png
  17. 0 0
      documentation/6.components/device-driver/i2c/i2c.md
  18. 0 0
      documentation/6.components/device-driver/pin/figures/pin2.png
  19. 0 0
      documentation/6.components/device-driver/pin/pin.md
  20. 0 0
      documentation/6.components/device-driver/pwm/figures/pwm-f.png
  21. 0 0
      documentation/6.components/device-driver/pwm/figures/pwm-l.png
  22. 0 0
      documentation/6.components/device-driver/pwm/pwm.md
  23. 0 0
      documentation/6.components/device-driver/rtc/rtc.md
  24. 0 0
      documentation/6.components/device-driver/sensor/sensor.md
  25. 0 0
      documentation/6.components/device-driver/spi/figures/spi1.png
  26. 0 0
      documentation/6.components/device-driver/spi/figures/spi2.png
  27. 0 0
      documentation/6.components/device-driver/spi/figures/spi5.png
  28. 0 0
      documentation/6.components/device-driver/spi/spi.md
  29. 0 0
      documentation/6.components/device-driver/uart/figures/uart-dma.png
  30. 0 0
      documentation/6.components/device-driver/uart/figures/uart-int.png
  31. 0 0
      documentation/6.components/device-driver/uart/figures/uart1.png
  32. 0 0
      documentation/6.components/device-driver/uart/uart.md
  33. 0 0
      documentation/6.components/device-driver/watchdog/watchdog.md
  34. 0 0
      documentation/6.components/device-driver/wlan/figures/an0026_1.png
  35. 0 0
      documentation/6.components/device-driver/wlan/figures/an0026_3.png
  36. 0 0
      documentation/6.components/device-driver/wlan/figures/an0026_4.png
  37. 0 0
      documentation/6.components/device-driver/wlan/figures/an0026_5.png
  38. 0 0
      documentation/6.components/device-driver/wlan/wlan.md
  39. 1 39
      documentation/INDEX.md

+ 2 - 1
documentation/6.components/INDEX.md

@@ -1,7 +1,8 @@
 @page page_components Components
 @page page_components Components
 
 
-- @subpage page_component_finsh
 - @subpage page_component_vfs
 - @subpage page_component_vfs
+- @subpage page_device
+- @subpage page_component_finsh
 - @subpage page_component_utest
 - @subpage page_component_utest
 - @subpage page_component_dlmodule
 - @subpage page_component_dlmodule
 - @subpage page_component_sal
 - @subpage page_component_sal

+ 1 - 1
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_framework
 - @subpage page_device_pin
 - @subpage page_device_pin

+ 0 - 0
documentation/5.device/adc/adc.md → documentation/6.components/device-driver/adc/adc.md


+ 0 - 0
documentation/5.device/adc/figures/adc-p.png → documentation/6.components/device-driver/adc/figures/adc-p.png


+ 0 - 0
documentation/5.device/audio/audio.md → documentation/6.components/device-driver/audio/audio.md


+ 0 - 0
documentation/5.device/framework/device.md → documentation/6.components/device-driver/framework/device.md


+ 0 - 0
documentation/5.device/framework/figures/block-dev.png → documentation/6.components/device-driver/framework/figures/block-dev.png


+ 0 - 0
documentation/5.device/framework/figures/io-call.png → documentation/6.components/device-driver/framework/figures/io-call.png


+ 0 - 0
documentation/5.device/framework/figures/io-dev.png → documentation/6.components/device-driver/framework/figures/io-dev.png


+ 0 - 0
documentation/5.device/framework/figures/io-fun-call.png → documentation/6.components/device-driver/framework/figures/io-fun-call.png


+ 0 - 0
documentation/5.device/framework/figures/io-parent.png → documentation/6.components/device-driver/framework/figures/io-parent.png


+ 0 - 0
documentation/5.device/framework/figures/wtd-uml.png → documentation/6.components/device-driver/framework/figures/wtd-uml.png


+ 0 - 0
documentation/5.device/hwtimer/hwtimer.md → documentation/6.components/device-driver/hwtimer/hwtimer.md


+ 0 - 0
documentation/5.device/i2c/figures/i2c1.png → documentation/6.components/device-driver/i2c/figures/i2c1.png


+ 0 - 0
documentation/5.device/i2c/figures/i2c2.png → documentation/6.components/device-driver/i2c/figures/i2c2.png


+ 0 - 0
documentation/5.device/i2c/figures/i2c3.png → documentation/6.components/device-driver/i2c/figures/i2c3.png


+ 0 - 0
documentation/5.device/i2c/i2c.md → documentation/6.components/device-driver/i2c/i2c.md


+ 0 - 0
documentation/5.device/pin/figures/pin2.png → documentation/6.components/device-driver/pin/figures/pin2.png


+ 0 - 0
documentation/5.device/pin/pin.md → documentation/6.components/device-driver/pin/pin.md


+ 0 - 0
documentation/5.device/pwm/figures/pwm-f.png → documentation/6.components/device-driver/pwm/figures/pwm-f.png


+ 0 - 0
documentation/5.device/pwm/figures/pwm-l.png → documentation/6.components/device-driver/pwm/figures/pwm-l.png


+ 0 - 0
documentation/5.device/pwm/pwm.md → documentation/6.components/device-driver/pwm/pwm.md


+ 0 - 0
documentation/5.device/rtc/rtc.md → documentation/6.components/device-driver/rtc/rtc.md


+ 0 - 0
documentation/5.device/sensor/sensor.md → documentation/6.components/device-driver/sensor/sensor.md


+ 0 - 0
documentation/5.device/spi/figures/spi1.png → documentation/6.components/device-driver/spi/figures/spi1.png


+ 0 - 0
documentation/5.device/spi/figures/spi2.png → documentation/6.components/device-driver/spi/figures/spi2.png


+ 0 - 0
documentation/5.device/spi/figures/spi5.png → documentation/6.components/device-driver/spi/figures/spi5.png


+ 0 - 0
documentation/5.device/spi/spi.md → documentation/6.components/device-driver/spi/spi.md


+ 0 - 0
documentation/5.device/uart/figures/uart-dma.png → documentation/6.components/device-driver/uart/figures/uart-dma.png


+ 0 - 0
documentation/5.device/uart/figures/uart-int.png → documentation/6.components/device-driver/uart/figures/uart-int.png


+ 0 - 0
documentation/5.device/uart/figures/uart1.png → documentation/6.components/device-driver/uart/figures/uart1.png


+ 0 - 0
documentation/5.device/uart/uart.md → documentation/6.components/device-driver/uart/uart.md


+ 0 - 0
documentation/5.device/watchdog/watchdog.md → documentation/6.components/device-driver/watchdog/watchdog.md


+ 0 - 0
documentation/5.device/wlan/figures/an0026_1.png → documentation/6.components/device-driver/wlan/figures/an0026_1.png


+ 0 - 0
documentation/5.device/wlan/figures/an0026_3.png → documentation/6.components/device-driver/wlan/figures/an0026_3.png


+ 0 - 0
documentation/5.device/wlan/figures/an0026_4.png → documentation/6.components/device-driver/wlan/figures/an0026_4.png


+ 0 - 0
documentation/5.device/wlan/figures/an0026_5.png → documentation/6.components/device-driver/wlan/figures/an0026_5.png


+ 0 - 0
documentation/5.device/wlan/wlan.md → documentation/6.components/device-driver/wlan/wlan.md


+ 1 - 39
documentation/INDEX.md

@@ -6,47 +6,9 @@
 
 
 @subpage page_kernel_core
 @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
 @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
 @subpage page_code_contribution