TarekSaeed0/chess

doc: add documentation to chess.h

開放

#2 建立於 2025年5月26日

在 GitHub 查看
 (0 則留言) (0 個反應) (0 位負責人)C (0 個分叉)auto 404
documentationgood first issue

倉庫指標

星標
 (0 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

adding Doxygen comments for the various types and functions in chess.h will help with new contributors and users of the library, understand the various types and functions defined and how to use them correctly, as currently the generated documentation is mostly empty.

貢獻者指南

研究方向
打開 chess.h 檔案，按照現有約定為每個類型和函式添加 Doxygen 註解。使用 `@param`、`@return`、`@brief` 標籤。
技術棧
c
領域
backend
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
C
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90