[drivers][adc] Fix misleading doxygen for rt_adc_voltage#11640
[drivers][adc] Fix misleading doxygen for rt_adc_voltage#11640mnikapl954 wants to merge 1 commit into
Conversation
📌 Code Review Assignment🏷️ Tag: componentsReviewers: @Maihuanyi Changed Files (Click to expand)
📊 Current Review Status (Last Updated: 2026-07-22 16:39 CST)
📝 Review Instructions
|
|
👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread! 为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。 🛠 操作步骤 | Steps
完成后,提交将自动更新至 如有问题欢迎联系我们,再次感谢您的贡献!💐 |
拉取/合并请求描述:(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: