RT-Thread / RT-Thread/rt-thread

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

Open
#9,424 3 comments 0 reactions 1 assignee View on GitHub

@wuming-zi is already working on this.

Since Feb 20, 2025.

good first issue
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

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.