Skip to content

[drivers][adc] Fix misleading doxygen for rt_adc_voltage#11640

Open
mnikapl954 wants to merge 1 commit into
RT-Thread:masterfrom
mnikapl954:fix/adc-voltage-doxygen
Open

[drivers][adc] Fix misleading doxygen for rt_adc_voltage#11640
mnikapl954 wants to merge 1 commit into
RT-Thread:masterfrom
mnikapl954:fix/adc-voltage-doxygen

Conversation

@mnikapl954

Copy link
Copy Markdown
Contributor

拉取/合并请求描述:(PR description)

为什么提交这份PR (why to submit this PR)

rt_adc_voltage() is documented as "get the adc resolution" and its @return says "adc resolution". That description belongs to resolution APIs, not voltage conversion, and confuses readers of the driver API docs (#9424 related doxygen quality).

你的解决方案是什么 (what is your solution)

Correct the @brief / @return text for rt_adc_voltage so it describes returning a converted voltage value.

Change is limited to doxygen comments in components/drivers/include/drivers/adc.h.

请提供验证的bsp和config (provide the config and bsp)

  • BSP: N/A (doxygen comment only)
  • Validation: checked function name and nearby ADC APIs in the same header

当前拉取/合并请求的状态 Intent for your PR

  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确 Style guide is adhered to
  • 没有垃圾代码 All redundant code is removed
  • 所有变更均有原因及合理的 All modifications are justified
  • 代码是高质量的 Code in this PR is of high quality

@github-actions

Copy link
Copy Markdown

📌 Code Review Assignment

🏷️ Tag: components

Reviewers: @Maihuanyi

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

📊 Current Review Status (Last Updated: 2026-07-22 16:39 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.

@github-actions

Copy link
Copy Markdown

👋 感谢您对 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:fix/adc-voltage-doxygen
  • 设置PR number为 \ Set the PR number to:11640
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将自动推送至你的分支。
    The formatted code will be automatically pushed to your branch.

完成后,提交将自动更新至 fix/adc-voltage-doxygen 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the fix/adc-voltage-doxygen 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!

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.

1 participant