Skip to content

Conversation

unicornx
Copy link
Contributor

@unicornx unicornx commented Sep 28, 2025

该问题是 11156de “feat[can]: Implement non-blocking send mechanism and enhance CAN driver functionality” 所引入的。

doxygen 注释中宏参数的名字和个数必须和宏的实际定义一致,否则会告警。

我们的目标是消除所有的告警。

The names and number of macro parameters in doxygen comments
must match the actual macro definition; otherwise, a warning
will be generated.

Our goal is to eliminate all warnings.

Signed-off-by: Chen Wang <[email protected]>
Copy link

👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).


🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  • 将目标分支设置为 \ Set the target branch to:dev-doxygen-fix-warning
  • 设置PR number为 \ Set the PR number to:10758
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将自动推送至你的分支。
    The formatted code will be automatically pushed to your branch.

完成后,提交将自动更新至 dev-doxygen-fix-warning 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the dev-doxygen-fix-warning branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们,再次感谢您的贡献!💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

Copy link

📌 Code Review Assignment

🏷️ Tag: components

Reviewers: @Maihuanyi

Changed Files (Click to expand)
  • components/drivers/include/drivers/dev_can.h

📊 Current Review Status (Last Updated: 2025-09-28 17:00 CST)


📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@unicornx unicornx requested a review from Rbb666 September 28, 2025 09:01
@unicornx
Copy link
Contributor Author

unicornx commented Sep 28, 2025

@wdfk-prog 请一起看一下,因为我发现这个问题是 11156de “feat[can]: Implement non-blocking send mechanism and enhance CAN driver functionality” 所引入的。你是这个补丁的作者。谢谢。

另外请注意:我发现 doxygen 不支持在注释中对参数标记为可选(optional), 所以对于这种不同宏下的同名不同参数的方式,只能分别写注释。而且因为默认 RT_CAN_USING_HDR 没有加入 documentation/Doxyfile 的 PREDEFINED,所以在生成 html 时默认显示的是 5 个参数的形式:

image

或许可以采用变参的方式定义宏?目前这种同名不同参数的方式也是很容易引起疑惑的,相当于两个API 了。

@unicornx
Copy link
Contributor Author

@Rbb666 有个建议,是否可以把 doxygen doc build 的 action 加入 ci,这样在 pr 提交阶段就可以发现这些告警了。

@Rbb666
Copy link
Member

Rbb666 commented Sep 28, 2025

有这个ci,后面合并的时候要关注下了😅:

image

@supperthomas supperthomas merged commit ace7fdb into RT-Thread:master Sep 28, 2025
57 checks passed
@unicornx unicornx deleted the dev-doxygen-fix-warning branch September 29, 2025 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants