Skip to content

Commit

Permalink
docs: add JSDocs for top level API objects (#140)
Browse files Browse the repository at this point in the history
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
lance authored May 12, 2020
1 parent f8a62b2 commit b283583
Show file tree
Hide file tree
Showing 60 changed files with 21,838 additions and 28 deletions.
2 changes: 1 addition & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"arrow-parens": ["error", "always"],
"arrow-body-style": ["error", "as-needed"],
"prefer-template": "error",
"max-len": ["warn", { "code": 80 }],
"max-len": ["warn", { "code": 120 }],
"no-unused-vars": ["warn", {
"argsIgnorePattern": "^_$|^e$|^reject$|^resolve$"
}],
Expand Down
29 changes: 29 additions & 0 deletions .jsdoc.json
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"
}
}
Loading

0 comments on commit b283583

Please sign in to comment.