RT-Thread/rt-thread

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

Open

#9,424 建立於 2024年9月11日

在 GitHub 查看
 (3 留言) (0 反應) (1 負責人)C (4,755 fork)batch import
good first issue

倉庫指標

Star
 (9,223 star)
PR 合併指標
 (平均合併 7天 22小時) (30 天內合併 50 個 PR)

描述

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

貢獻者指南

研究方向
關注位於 components/drivers/include/drivers 的驅動標頭檔。選擇一個驅動檔案（例如 drivers/include/drivers/rt device.h），為現有的函式和資料結構添加 Doxygen 註釋。請參考 https://supperthomas.github.io/RTT doxygen API/ 中的範例作為風格指南。確保在文件註釋中包含一個簡要的使用範例。完成一個驅動後，提交一個拉取請求，並根據回饋進行迭代。
技術棧
c
領域
backenddocumentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
CDoxygen
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75