apache / apache/cordova-node-xcode
Add & Improve JSDocs
未关闭
enhancement
- 主要语言
- JavaScript
- 星标
- 217
- 派生
- 102
- 平均合并
- 2 天 3 小时
- 30 天内合并 PR
- 6
描述
## Goal
The goal of this ticket is to investigate and expand the project's JSDoc coverage to improve in-code documentation and make the codebase easier to understand and maintain.
## Bonus
Explore options for extracting and rendering the JSDocs as a static documentation site.
There are tools available that can generate Markdown from JSDoc comments, making it possible to use a GitHub Action to build and deploy the documentation automatically.
---
## List of APIs
TODO: Create a checkbox list of all APIs and check them when JSDocs are added or improved.
贡献指南
评估
这个 Issue 还没有评估数据。