esp8266/Arduino

Create API reference

Open

#18 建立於 2015年3月30日

在 GitHub 查看
 (10 留言) (0 反應) (0 負責人)C++ (15,728 star) (13,342 fork)batch import
component: documentationhelp wanted

描述

Describe all the basic APIs and the libraries by adding documentation to the repository or to the wiki.

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

貢獻者指南

技術棧
ccpp
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
3-5 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Basic knowledge of ESP8266 Arduino librariesFamiliarity with Markdown
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
35
研究方向
Examine the existing library source files (e.g., in the libraries/ directory) to identify all public APIs and functions. Document them in a structured format such as Markdown. Consider using a documentation generator like Doxygen if applicable. Check the 10 comments on the issue for any prior discussion about scope and preferred format.