diff options
| author | Chen Wang <[email protected]> | 2025-05-29 09:57:53 +0800 |
|---|---|---|
| committer | Rbb666 <[email protected]> | 2025-05-29 13:47:46 +0800 |
| commit | 52acf7a4132acb843d1c36c1fadd1209dfd86633 (patch) | |
| tree | d68ff87034f6fd2fc5717d3a6eb52ec5741cfa1f | |
| parent | a3339ca734adb30c4b1f598b1283560f010a21b5 (diff) | |
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 <[email protected]>
| -rw-r--r-- | documentation/6.components/INDEX.md | 3 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/INDEX.md (renamed from documentation/5.device/INDEX.md) | 2 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/adc/adc.md (renamed from documentation/5.device/adc/adc.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/adc/figures/adc-p.png (renamed from documentation/5.device/adc/figures/adc-p.png) | bin | 32160 -> 32160 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/audio/audio.md (renamed from documentation/5.device/audio/audio.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/framework/device.md (renamed from documentation/5.device/framework/device.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/framework/figures/block-dev.png (renamed from documentation/5.device/framework/figures/block-dev.png) | bin | 14360 -> 14360 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/framework/figures/io-call.png (renamed from documentation/5.device/framework/figures/io-call.png) | bin | 17519 -> 17519 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/framework/figures/io-dev.png (renamed from documentation/5.device/framework/figures/io-dev.png) | bin | 20837 -> 20837 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/framework/figures/io-fun-call.png (renamed from documentation/5.device/framework/figures/io-fun-call.png) | bin | 16301 -> 16301 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/framework/figures/io-parent.png (renamed from documentation/5.device/framework/figures/io-parent.png) | bin | 20021 -> 20021 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/framework/figures/wtd-uml.png (renamed from documentation/5.device/framework/figures/wtd-uml.png) | bin | 47264 -> 47264 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/hwtimer/hwtimer.md (renamed from documentation/5.device/hwtimer/hwtimer.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/i2c/figures/i2c1.png (renamed from documentation/5.device/i2c/figures/i2c1.png) | bin | 9696 -> 9696 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/i2c/figures/i2c2.png (renamed from documentation/5.device/i2c/figures/i2c2.png) | bin | 14946 -> 14946 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/i2c/figures/i2c3.png (renamed from documentation/5.device/i2c/figures/i2c3.png) | bin | 7749 -> 7749 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/i2c/i2c.md (renamed from documentation/5.device/i2c/i2c.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/pin/figures/pin2.png (renamed from documentation/5.device/pin/figures/pin2.png) | bin | 16419 -> 16419 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/pin/pin.md (renamed from documentation/5.device/pin/pin.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/pwm/figures/pwm-f.png (renamed from documentation/5.device/pwm/figures/pwm-f.png) | bin | 15113 -> 15113 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/pwm/figures/pwm-l.png (renamed from documentation/5.device/pwm/figures/pwm-l.png) | bin | 10754 -> 10754 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/pwm/pwm.md (renamed from documentation/5.device/pwm/pwm.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/rtc/rtc.md (renamed from documentation/5.device/rtc/rtc.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/sensor/sensor.md (renamed from documentation/5.device/sensor/sensor.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/spi/figures/spi1.png (renamed from documentation/5.device/spi/figures/spi1.png) | bin | 8051 -> 8051 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/spi/figures/spi2.png (renamed from documentation/5.device/spi/figures/spi2.png) | bin | 10016 -> 10016 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/spi/figures/spi5.png (renamed from documentation/5.device/spi/figures/spi5.png) | bin | 46773 -> 46773 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/spi/spi.md (renamed from documentation/5.device/spi/spi.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/uart/figures/uart-dma.png (renamed from documentation/5.device/uart/figures/uart-dma.png) | bin | 40241 -> 40241 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/uart/figures/uart-int.png (renamed from documentation/5.device/uart/figures/uart-int.png) | bin | 40997 -> 40997 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/uart/figures/uart1.png (renamed from documentation/5.device/uart/figures/uart1.png) | bin | 3366 -> 3366 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/uart/uart.md (renamed from documentation/5.device/uart/uart.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/watchdog/watchdog.md (renamed from documentation/5.device/watchdog/watchdog.md) | 0 | ||||
| -rw-r--r-- | documentation/6.components/device-driver/wlan/figures/an0026_1.png (renamed from documentation/5.device/wlan/figures/an0026_1.png) | bin | 55699 -> 55699 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/wlan/figures/an0026_3.png (renamed from documentation/5.device/wlan/figures/an0026_3.png) | bin | 27638 -> 27638 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/wlan/figures/an0026_4.png (renamed from documentation/5.device/wlan/figures/an0026_4.png) | bin | 33411 -> 33411 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/wlan/figures/an0026_5.png (renamed from documentation/5.device/wlan/figures/an0026_5.png) | bin | 54530 -> 54530 bytes | |||
| -rw-r--r-- | documentation/6.components/device-driver/wlan/wlan.md (renamed from documentation/5.device/wlan/wlan.md) | 0 | ||||
| -rw-r--r-- | documentation/INDEX.md | 40 |
39 files changed, 4 insertions, 41 deletions
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 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 index dbc09a34f4..dbc09a34f4 100644 --- a/documentation/5.device/adc/adc.md +++ b/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 Binary files differindex 26c6e9bfc3..26c6e9bfc3 100644 --- a/documentation/5.device/adc/figures/adc-p.png +++ b/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 index 358b78bf05..358b78bf05 100644 --- a/documentation/5.device/audio/audio.md +++ b/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 index bebf72e76c..bebf72e76c 100644 --- a/documentation/5.device/framework/device.md +++ b/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 Binary files differindex 510e3d516a..510e3d516a 100644 --- a/documentation/5.device/framework/figures/block-dev.png +++ b/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 Binary files differindex 0fc097c322..0fc097c322 100644 --- a/documentation/5.device/framework/figures/io-call.png +++ b/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 Binary files differindex 50fd63f954..50fd63f954 100644 --- a/documentation/5.device/framework/figures/io-dev.png +++ b/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 Binary files differindex 49a77f7681..49a77f7681 100644 --- a/documentation/5.device/framework/figures/io-fun-call.png +++ b/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 Binary files differindex 7c87db7f20..7c87db7f20 100644 --- a/documentation/5.device/framework/figures/io-parent.png +++ b/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 Binary files differindex 8fecc92aec..8fecc92aec 100644 --- a/documentation/5.device/framework/figures/wtd-uml.png +++ b/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 index 0e2e9767f7..0e2e9767f7 100644 --- a/documentation/5.device/hwtimer/hwtimer.md +++ b/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 Binary files differindex 7b3b2d204d..7b3b2d204d 100644 --- a/documentation/5.device/i2c/figures/i2c1.png +++ b/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 Binary files differindex 58f83b7461..58f83b7461 100644 --- a/documentation/5.device/i2c/figures/i2c2.png +++ b/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 Binary files differindex a8ad1a1c93..a8ad1a1c93 100644 --- a/documentation/5.device/i2c/figures/i2c3.png +++ b/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 index cd899d992b..cd899d992b 100644 --- a/documentation/5.device/i2c/i2c.md +++ b/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 Binary files differindex d51371fecc..d51371fecc 100644 --- a/documentation/5.device/pin/figures/pin2.png +++ b/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 index c7c03eaa12..c7c03eaa12 100644 --- a/documentation/5.device/pin/pin.md +++ b/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 Binary files differindex 1c6c7370cc..1c6c7370cc 100644 --- a/documentation/5.device/pwm/figures/pwm-f.png +++ b/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 Binary files differindex e793b2cfca..e793b2cfca 100644 --- a/documentation/5.device/pwm/figures/pwm-l.png +++ b/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 index f313ee1dd1..f313ee1dd1 100644 --- a/documentation/5.device/pwm/pwm.md +++ b/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 index 696607338d..696607338d 100644 --- a/documentation/5.device/rtc/rtc.md +++ b/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 index da03c7900a..da03c7900a 100644 --- a/documentation/5.device/sensor/sensor.md +++ b/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 Binary files differindex 2096701713..2096701713 100644 --- a/documentation/5.device/spi/figures/spi1.png +++ b/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 Binary files differindex 55c3188d55..55c3188d55 100644 --- a/documentation/5.device/spi/figures/spi2.png +++ b/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 Binary files differindex 2e71536451..2e71536451 100644 --- a/documentation/5.device/spi/figures/spi5.png +++ b/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 index b4c7950c35..b4c7950c35 100644 --- a/documentation/5.device/spi/spi.md +++ b/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 Binary files differindex 1415e8552a..1415e8552a 100644 --- a/documentation/5.device/uart/figures/uart-dma.png +++ b/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 Binary files differindex c500f22d27..c500f22d27 100644 --- a/documentation/5.device/uart/figures/uart-int.png +++ b/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 Binary files differindex 7e52536f72..7e52536f72 100644 --- a/documentation/5.device/uart/figures/uart1.png +++ b/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 index 8f1784ced3..8f1784ced3 100644 --- a/documentation/5.device/uart/uart.md +++ b/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 index 330b24bba5..330b24bba5 100644 --- a/documentation/5.device/watchdog/watchdog.md +++ b/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 Binary files differindex 6686efbcfe..6686efbcfe 100644 --- a/documentation/5.device/wlan/figures/an0026_1.png +++ b/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 Binary files differindex 016d60b0e4..016d60b0e4 100644 --- a/documentation/5.device/wlan/figures/an0026_3.png +++ b/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 Binary files differindex a383cbba5d..a383cbba5d 100644 --- a/documentation/5.device/wlan/figures/an0026_4.png +++ b/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 Binary files differindex d3b88a0e93..d3b88a0e93 100644 --- a/documentation/5.device/wlan/figures/an0026_5.png +++ b/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 index 8d2cb3da2a..8d2cb3da2a 100644 --- a/documentation/5.device/wlan/wlan.md +++ b/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_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 |
