apache / apache/cordova-node-xcode

Add & Improve JSDocs

Offen
#171 0 Kommentare 0 Reaktionen 1 zugewiesene Person Beansprucht von @erisu Auf GitHub ansehen
enhancement
Vorherrschende Sprache
JavaScript
Sterne
217
Forks
102
Ø Merge
2 T. 3 Std.
Gemergte PRs (30 T.)
6

Beschreibung

## 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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.