RT-Thread/rt-thread

[Feature] [doc] doxygen文档中缺少driver相关的doxygen

开放

#9,424 创建于 2024年9月11日

在 GitHub 查看贡献者指南
 (3 条评论) (0 个反应) (1 位负责人)C (4,755 个派生)batch import
good first issue

仓库指标

星标
 (9,223 个星标)
PR 合并指标
 (平均合并 7天 22小时) (30 天内合并 50 个 PR)

描述

Describe problem solved by the proposed feature

https://github.com/RT-Thread/rt-thread/tree/master/components/drivers/include/drivers

目前driver相关的doxygen中缺少一些注释，希望能添加doxygen注释和对应的example，方便后续开发和维护

Describe your preferred solution

参考doxygen链接 https://supperthomas.github.io/RTT_doxygen_API/

Describe possible alternatives

No response

贡献者指南

研究方向
关注位于 components/drivers/include/drivers 的驱动头文件。选择一个驱动文件（例如 drivers/include/drivers/rt device.h），为现有的函数和数据结构添加 Doxygen 注释。请参考 https://supperthomas.github.io/RTT doxygen API/ 中的示例作为风格指南。确保在文档注释中包含一个简要的使用示例。完成一个驱动后，提交一个拉取请求，并根据反馈进行迭代。
技术栈
c
领域
backenddocumentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
CDoxygen
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75