RT-Thread/rt-thread

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

Open

#9,424 opened on Sep 11, 2024

View on GitHub
 (3 comments) (0 reactions) (1 assignee)C (4,755 forks)batch import
good first issue

Repository metrics

Stars
 (9,223 stars)
PR merge metrics
 (Avg merge 7d 22h) (50 merged PRs in 30d)

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

Research direction
Review the driver header files in components/drivers/include/drivers and add Doxygen comments following the style in the provided example link.
Tech stack
c
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
CDoxygen
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75