RT-Thread / RT-Thread/rt-thread
[Feature] lwp, dm 等组件需要补充 doxygen 注释 | Add Doxygen Comments for Components
Open
@unicornx is already working on this.
Since Dec 3, 2024.
good first issue
RT-Smart
- Dominant language
- C
- Stars
- 12.2k
- Forks
- 5.4k
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 40
Description
Describe problem solved by the proposed feature
目前，RT-Thread 中的部分组件（如 lwp, dm) 缺少完整的 Doxygen 注释。这些注释对于开发者理解和使用这些组件非常重要。补充完整的 Doxygen 注释将有助于提升代码的可读性和可维护性，并且有助于新开发者快速上手。
需求:
- 为 lwp 组件的所有公共接口、数据结构和函数补充详细的 Doxygen 注释。
- 为 dd2.0 组件的所有公共接口、数据结构和函数补充详细的 Doxygen 注释。
确保注释涵盖以下内容：
- 功能描述
- 参数说明
- 返回值说明
- 任何异常或特殊情况的处理
- 遵循 RT-Thread 现有的注释风格和 Doxygen 规范。
Describe your preferred solution
No response
Describe possible alternatives
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.