feature: jsdoc annotations and generation #177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4141done
commented
Oct 2, 2023
| @@ -1,7 +1,58 @@ | |||
| # Created by https://www.toptal.com/developers/gitignore/api/intellij | |||
| # Edit at https://www.toptal.com/developers/gitignore?templates=intellij | |||
| # Created by https://www.toptal.com/developers/gitignore/api/intellij+all,node,vim,emacs,macos | |||
There was a problem hiding this comment.
Annotation:
gitignore changes are primarily to take care of the new nodejs depenedency for docs builds.
| @@ -53,6 +107,12 @@ cmake-build-*/ | |||
| # IntelliJ | |||
| out/ | |||
|
|
|||
| # jsdoc build directory | |||
There was a problem hiding this comment.
Annotation:
This is added to ignore the built documentation.
|
|
||
| docs_destination_directory = "reference" | ||
|
|
||
| .PHONY: docs |
There was a problem hiding this comment.
Annotation:
This may not be the correct thing to do, but without it I could not get the make jsdoc make clean make jsdoc flow to work correctly.
I figure it's safer to build the docs every time anyway. In a CI context this shouldn't matter.
4141done
changed the title
elJosho
pushed a commit
to elJosho/nginx-s3-gateway
that referenced
this pull request
Oct 25, 2023
# 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: nginxinc#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 ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: #163
Usage
To generate the documentation run:
It will be located in the
./referencefolder at the root of the projectTo generate and view the documentation in a browser, run:
To remove generated documentation, run: