Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] lwp, dm 等组件需要补充 doxygen 注释 | Add Doxygen Comments for Components #9263

Open
2 tasks
polarvid opened this issue Jul 29, 2024 · 2 comments
Assignees
Labels
good first issue Good for newcomers 新手任务 RT-Smart RT-Thread Smart related PR or issues

Comments

@polarvid
Copy link
Contributor

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

@polarvid polarvid added good first issue Good for newcomers 新手任务 RT-Smart RT-Thread Smart related PR or issues labels Jul 29, 2024
@unicornx unicornx self-assigned this Dec 3, 2024
@unicornx
Copy link
Contributor

unicornx commented Dec 3, 2024

应该还有一些其他的模块都存在这个问题,我会分解一下,一边学习一边把注释都加上。

@unicornx
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers 新手任务 RT-Smart RT-Thread Smart related PR or issues
Projects
None yet
Development

No branches or pull requests

2 participants