apache / apache/cordova-node-xcode

Add & Improve JSDocs

オープン
#171 コメント 0 件 リアクション 0 件 担当者 1 名 @erisu が担当を希望しています GitHub で見る
enhancement
主要言語
JavaScript
スター
217
フォーク
102
平均マージ
2日 3時間
マージ済み PR(30日)
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 はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。