doxygen: fix two issues when building with doxygen 1.9.8 #10768
Conversation
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]>
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]>
github-actions
bot
added
Doc
📌 Code Review Assignment🏷️ Tag: componentsReviewers: @Maihuanyi Changed Files (Click to expand)
🏷️ Tag: documentationReviewers: @CXSforHPU @GorrayLi @lianux-mm @unicornx Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2025-10-09 15:10 CST)
📝 Review Instructions
|
|
👋 感谢您对 RT-Thread 的贡献！Thank you for your contribution to RT-Thread! 为确保代码符合 RT-Thread 的编码规范，请在你的仓库中执行以下步骤运行代码格式化工作流（如果格式化CI运行失败）。 🛠 操作步骤 | Steps
完成后，提交将自动更新至 如有问题欢迎联系我们，再次感谢您的贡献！💐 |
unicornx
changed the title
unicornx
requested review from
Rbb666
and removed request for
Cathy-lulu and
mysterywolf
There was a problem hiding this comment.
Pull Request Overview
This PR fixes two documentation issues that cause errors when building with Doxygen 1.9.8, while these issues don't appear with Doxygen 1.9.1. The changes ensure compatibility with newer Doxygen versions.
- Remove
@return voidcommands from functions that return void, as Doxygen 1.9.8 treats this as an error - Fix a minor typo in UART documentation that causes build errors in Doxygen 1.9.8
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| documentation/6.components/device-driver/uart/uart.md | Fixes typo in backtick formatting for RT_DEVICE_FLAG_STREAM documentation |
| documentation/0.doxygen/example/src/function.c | Updates documentation guidelines and removes @return void from example |
| components/drivers/include/drivers/dev_can.h | Removes @return void from rt_hw_can_isr function documentation |
| components/drivers/audio/dev_audio.c | Removes @return void from two function documentations |
2 participants
本 PR 包含两个 commit，分别修复了两个使用 doxygen 1.9.8 build 时发现的一些错误，这些问题使用 doxygen 1.9.1 构建时没有报错。ubuntu 22.04 默认安装的是 doxygen 1.9.1，但 ubunttu 24.04 默认安装的是 doxygen 1.9.8。
@return