apache / apache/cordova-node-xcode
Add & Improve JSDocs
Aperta
enhancement
- Lingua principale
- JavaScript
- Stelle
- 217
- Fork
- 102
- Merge medio
- 2g 3h
- PR unite (30g)
- 6
Descrizione
## 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.
Guida per i contributori
Apri la guida per i contributori
Valutazione
Questa issue non è ancora stata valutata.