-
Notifications
You must be signed in to change notification settings - Fork 69
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add JSDocs for top level API objects (#140)
This commit add JSDoc documentation to the CloudEvent and HTTPReceiver objects exposed by the API when using the top level imports, specifically `CloudEvent` and `HTTPReceiver`. This adds a `generate-docs` npm script to generate site and API documentation for GitHub pages in `./docs`. Signed-off-by: Lance Ball <lball@redhat.com>
- Loading branch information
Showing
60 changed files
with
21,838 additions
and
28 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
{ | ||
"tags": { | ||
"allowUnknownTags": true, | ||
"dictionaries": ["jsdoc"] | ||
}, | ||
"source": { | ||
"include": ["lib", "package.json", "README.md"], | ||
"includePattern": ".js$", | ||
"excludePattern": "(node_modules/|docs|examples|coverage|test)" | ||
}, | ||
"plugins": [ | ||
"plugins/markdown" | ||
], | ||
"templates": { | ||
"referenceTitle": "cloudevents-sdk", | ||
"disableSort": false, | ||
"collapse": true, | ||
"resources": { | ||
"Concepts": "concepts.html" | ||
} | ||
}, | ||
"opts": { | ||
"destination": "./docs/", | ||
"encoding": "utf8", | ||
"private": true, | ||
"recurse": true, | ||
"template": "node_modules/jsdoc-fresh" | ||
} | ||
} |
Oops, something went wrong.