You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
👋 感谢您对 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).
设置需排除的文件/目录(目录请以"/"结尾)
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
等待工作流完成 | 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!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
拉取/合并请求描述:(PR description)
为什么提交这份PR (why to submit this PR)
rt_adc_voltage()is documented as "get the adc resolution" and its@returnsays "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/@returntext forrt_adc_voltageso 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)
当前拉取/合并请求的状态 Intent for your PR
代码质量 Code Quality: