From 52acf7a4132acb843d1c36c1fadd1209dfd86633 Mon Sep 17 00:00:00 2001 From: Chen Wang Date: Thu, 29 May 2025 09:57:53 +0800 Subject: [PATCH] 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 --- documentation/6.components/INDEX.md | 3 +- .../device-driver}/INDEX.md | 2 +- .../device-driver}/adc/adc.md | 0 .../device-driver}/adc/figures/adc-p.png | Bin .../device-driver}/audio/audio.md | 0 .../device-driver}/framework/device.md | 0 .../framework/figures/block-dev.png | Bin .../framework/figures/io-call.png | Bin .../framework/figures/io-dev.png | Bin .../framework/figures/io-fun-call.png | Bin .../framework/figures/io-parent.png | Bin .../framework/figures/wtd-uml.png | Bin .../device-driver}/hwtimer/hwtimer.md | 0 .../device-driver}/i2c/figures/i2c1.png | Bin .../device-driver}/i2c/figures/i2c2.png | Bin .../device-driver}/i2c/figures/i2c3.png | Bin .../device-driver}/i2c/i2c.md | 0 .../device-driver}/pin/figures/pin2.png | Bin .../device-driver}/pin/pin.md | 0 .../device-driver}/pwm/figures/pwm-f.png | Bin .../device-driver}/pwm/figures/pwm-l.png | Bin .../device-driver}/pwm/pwm.md | 0 .../device-driver}/rtc/rtc.md | 0 .../device-driver}/sensor/sensor.md | 0 .../device-driver}/spi/figures/spi1.png | Bin .../device-driver}/spi/figures/spi2.png | Bin .../device-driver}/spi/figures/spi5.png | Bin .../device-driver}/spi/spi.md | 0 .../device-driver}/uart/figures/uart-dma.png | Bin .../device-driver}/uart/figures/uart-int.png | Bin .../device-driver}/uart/figures/uart1.png | Bin .../device-driver}/uart/uart.md | 0 .../device-driver}/watchdog/watchdog.md | 0 .../device-driver}/wlan/figures/an0026_1.png | Bin .../device-driver}/wlan/figures/an0026_3.png | Bin .../device-driver}/wlan/figures/an0026_4.png | Bin .../device-driver}/wlan/figures/an0026_5.png | Bin .../device-driver}/wlan/wlan.md | 0 documentation/INDEX.md | 40 +----------------- 39 files changed, 4 insertions(+), 41 deletions(-) rename documentation/{5.device => 6.components/device-driver}/INDEX.md (92%) rename documentation/{5.device => 6.components/device-driver}/adc/adc.md (100%) rename documentation/{5.device => 6.components/device-driver}/adc/figures/adc-p.png (100%) rename documentation/{5.device => 6.components/device-driver}/audio/audio.md (100%) rename documentation/{5.device => 6.components/device-driver}/framework/device.md (100%) rename documentation/{5.device => 6.components/device-driver}/framework/figures/block-dev.png (100%) rename documentation/{5.device => 6.components/device-driver}/framework/figures/io-call.png (100%) rename documentation/{5.device => 6.components/device-driver}/framework/figures/io-dev.png (100%) rename documentation/{5.device => 6.components/device-driver}/framework/figures/io-fun-call.png (100%) rename documentation/{5.device => 6.components/device-driver}/framework/figures/io-parent.png (100%) rename documentation/{5.device => 6.components/device-driver}/framework/figures/wtd-uml.png (100%) rename documentation/{5.device => 6.components/device-driver}/hwtimer/hwtimer.md (100%) rename documentation/{5.device => 6.components/device-driver}/i2c/figures/i2c1.png (100%) rename documentation/{5.device => 6.components/device-driver}/i2c/figures/i2c2.png (100%) rename documentation/{5.device => 6.components/device-driver}/i2c/figures/i2c3.png (100%) rename documentation/{5.device => 6.components/device-driver}/i2c/i2c.md (100%) rename documentation/{5.device => 6.components/device-driver}/pin/figures/pin2.png (100%) rename documentation/{5.device => 6.components/device-driver}/pin/pin.md (100%) rename documentation/{5.device => 6.components/device-driver}/pwm/figures/pwm-f.png (100%) rename documentation/{5.device => 6.components/device-driver}/pwm/figures/pwm-l.png (100%) rename documentation/{5.device => 6.components/device-driver}/pwm/pwm.md (100%) rename documentation/{5.device => 6.components/device-driver}/rtc/rtc.md (100%) rename documentation/{5.device => 6.components/device-driver}/sensor/sensor.md (100%) rename documentation/{5.device => 6.components/device-driver}/spi/figures/spi1.png (100%) rename documentation/{5.device => 6.components/device-driver}/spi/figures/spi2.png (100%) rename documentation/{5.device => 6.components/device-driver}/spi/figures/spi5.png (100%) rename documentation/{5.device => 6.components/device-driver}/spi/spi.md (100%) rename documentation/{5.device => 6.components/device-driver}/uart/figures/uart-dma.png (100%) rename documentation/{5.device => 6.components/device-driver}/uart/figures/uart-int.png (100%) rename documentation/{5.device => 6.components/device-driver}/uart/figures/uart1.png (100%) rename documentation/{5.device => 6.components/device-driver}/uart/uart.md (100%) rename documentation/{5.device => 6.components/device-driver}/watchdog/watchdog.md (100%) rename documentation/{5.device => 6.components/device-driver}/wlan/figures/an0026_1.png (100%) rename documentation/{5.device => 6.components/device-driver}/wlan/figures/an0026_3.png (100%) rename documentation/{5.device => 6.components/device-driver}/wlan/figures/an0026_4.png (100%) rename documentation/{5.device => 6.components/device-driver}/wlan/figures/an0026_5.png (100%) rename documentation/{5.device => 6.components/device-driver}/wlan/wlan.md (100%) diff --git a/documentation/6.components/INDEX.md b/documentation/6.components/INDEX.md index 1a7dc8c873..d73a8907f9 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 6fa9e66d7c..010d0fc910 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 70f0d9c345..d13bacfe2f 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_components @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_code_contribution