rt-thread/documentation/6.components/device-driver
Chen Wang 273185b45a
doxygen: fix two issues when building with doxygen 1.9.8 (#10768)
* 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 <unicorn_wang@outlook.com>

* 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 <unicorn_wang@outlook.com>
2025-10-10 10:05:06 +08:00
..
adc doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
audio doxygen: group name all in lowcase (part 2) (#10530) 2025-07-22 13:59:25 +08:00
framework doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
hwtimer doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
i2c doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
ofw [TOOLS] Add DTC (Devicetree Compiler) tools 2025-06-30 09:42:39 +08:00
pin doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
pwm doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
rtc doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
sensor doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
spi doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
uart doxygen: fix two issues when building with doxygen 1.9.8 (#10768) 2025-10-10 10:05:06 +08:00
watchdog doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
wlan doxygen: move device_driver under to components for pages 2025-05-29 13:47:46 +08:00
INDEX.md [TOOLS] Add DTC (Devicetree Compiler) tools 2025-06-30 09:42:39 +08:00