nginxinc / nginx-s3-gateway

NGINX S3 Caching Gateway
Apache License 2.0
515 stars 127 forks source link

feature: jsdoc annotations and generation #177

Closed 4141done closed 1 year ago

4141done commented 1 year ago

What

Adds the ability to generate a website with reference documentation based on JSDoc annotations in the Javascript code. Annotations are also added. This will help you if you use an editor that knows how to parse JSDoc annotations.

This change adds a workflow that depends on NodeJS however, normal usage of the gateway will not require NodeJs, nor will any development workflows. In the future, development workflows will require NodeJs. Discussion on this topic here: https://github.com/nginxinc/nginx-s3-gateway/discussions/163

Usage

To generate the documentation run:

make jsdoc

It will be located in the ./reference folder at the root of the project

To generate and view the documentation in a browser, run:

make jsdoc-open

To remove generated documentation, run:

make clean