Skip to content

Commit b283583

Browse files
authored
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>
1 parent f8a62b2 commit b283583

Some content is hidden

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

60 files changed

+21838
-28
lines changed

Diff for: .eslintrc

+1-1
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
}],

Diff for: .jsdoc.json

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
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|examples|coverage|test)"
10+
},
11+
"plugins": [
12+
"plugins/markdown"
13+
],
14+
"templates": {
15+
"referenceTitle": "cloudevents-sdk",
16+
"disableSort": false,
17+
"collapse": true,
18+
"resources": {
19+
"Concepts": "concepts.html"
20+
}
21+
},
22+
"opts": {
23+
"destination": "./docs/",
24+
"encoding": "utf8",
25+
"private": true,
26+
"recurse": true,
27+
"template": "node_modules/jsdoc-fresh"
28+
}
29+
}

0 commit comments

Comments
 (0)