forked from newrelic/node-newrelic
-
Notifications
You must be signed in to change notification settings - Fork 1
/
jsdoc-conf.jsonc
39 lines (39 loc) · 1.04 KB
/
jsdoc-conf.jsonc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
"opts": {
"destination": "out/",
"readme": "./README.md",
"template": "./node_modules/clean-jsdoc-theme",
"theme_opts": {
"search": false,
"shouldRemoveScrollbarStyle": true
},
"tutorials": "examples/shim",
"recurse": true
},
"source": {
"exclude": ["node_modules", "test"],
"includePattern": ".+\\.js(doc)?$",
// Note: we cannot add patterns to the "include" strings. They must be
// explicit strings that point to either specific files or directories.
// Recursion is enabled for the `jsdoc` command, thus any directories
// specified here will be processed recursively. So make sure any files in
// these directories should be included in our public docs.
"include": [
"api.js",
"lib/shim/",
"lib/transaction/handle.js",
"lib/instrumentation-descriptor.js"
]
},
"plugins": [
"plugins/markdown"
],
"templates": {
"cleverLinks": true,
"showInheritedInNav": false
},
"markdown": {
"hardwrap": false,
"idInHeadings": true
}
}