summaryrefslogtreecommitdiff
path: root/documentation/6.components/device-driver/uart/uart.md
AgeCommit message (Collapse)Author
2026-05-28[docs] device-driver: add DM subsystem docs and expand INDEXGuEe-GUI
Add Doxygen pages for RT-Thread device-model drivers: platform/OFW, DM core (bus, dm, power), clk/regulator/reset/power-domain, PCI/PIC, Phye, DMA/hwcache, block/SCSI/ATA/NVMe/UFS/SDIO, SCMI, RPMsg, mailbox, NVMem, NUMA, syscon, thermal, input/LED/IIO/graphic, and related power/charger/supply docs. Expand device-driver INDEX.md with ~90 @subpage entries so all new pages appear in the driver chapter navigation. Update existing UART/SPI/RTC/pin/framework/dtc pages: UART docs moved from serial/ to uart/ (uart + uart_dm + uart_earlycon); SPI and RTC gain DM companion pages; pin links to pin_dm; framework points at DM topics. Focus on registration/probe flow and in-tree APIs; no standalone VirtIO subsystem page (transport code still incomplete). Test plan: build Doxygen for documentation/ and verify device-driver INDEX links resolve without missing @ref/@subpage warnings. Signed-off-by: GuEe-GUI <[email protected]>
2025-10-10doxygen: fix two issues when building with doxygen 1.9.8 (#10768)Chen Wang
* doxygen: remove @return command if function return void When doxygen is upgraded to v1.9.8 (on ubuntu 24.04), doxygen reports: "doxygen error: found documented return type for xxx that does not return anything" for those functions which return void but declare "@return" in doxygen comment. Solution: remove "@return" for those cases, and update guide document for how to write doxgen comment for functions. Signed-off-by: Chen Wang <[email protected]> * doxygen: fixed a minor typo for uart doc This error is found when building with doxygen 1.9.8, but not detecetd on 1.9.1. Signed-off-by: Chen Wang <[email protected]>
2025-05-29doxygen: move device_driver under to components for pagesChen Wang
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]>