RT-Thread/rt-thread
在 GitHub 查看[Feature] lwp, dm 等组件需要补充 doxygen 注释 | Add Doxygen Comments for Components
Open
#9,263 建立於 2024年7月29日
RT-Smartgood first issue
倉庫指標
- Star
- (9,223 star)
- PR 合併指標
- (平均合併 7天 22小時) (30 天內合併 50 個 PR)
描述
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