Skip to content

Commit b26a172

Browse files
committed
docs: add JSDocs for top level API objects
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 <[email protected]>
1 parent ef7550d commit b26a172

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+21708
-28
lines changed

.eslintrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
"arrow-parens": ["error", "always"],
1414
"arrow-body-style": ["error", "as-needed"],
1515
"prefer-template": "error",
16-
"max-len": ["warn", { "code": 80 }],
16+
"max-len": ["warn", { "code": 120 }],
1717
"no-unused-vars": ["warn", {
1818
"argsIgnorePattern": "^_$|^e$|^reject$|^resolve$"
1919
}],

.jsdoc.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"tags": {
3+
"allowUnknownTags": true,
4+
"dictionaries": ["jsdoc"]
5+
},
6+
"source": {
7+
"include": ["lib", "package.json", "README.md"],
8+
"includePattern": ".js$",
9+
"excludePattern": "(node_modules/|docs)"
10+
},
11+
"plugins": [
12+
"plugins/markdown"
13+
],
14+
"templates": {
15+
"referenceTitle": "cloudevents-sdk",
16+
"disableSort": false,
17+
"collapse": true
18+
},
19+
"opts": {
20+
"destination": "./docs/",
21+
"encoding": "utf8",
22+
"private": true,
23+
"recurse": true,
24+
"template": "node_modules/jsdoc-fresh"
25+
}
26+
}

0 commit comments

Comments
 (0)