apache / apache/cordova-node-xcode

Add & Improve JSDocs

Open
#171 0 comments 0 reactions 1 assignee Claimed by @erisu View on GitHub
enhancement
Dominant language
JavaScript
Stars
217
Forks
102
Avg merge
2d 3h
Merged PRs (30d)
6

Description

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.