-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathjsdoc.json
42 lines (41 loc) · 1.63 KB
/
jsdoc.json
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
40
41
42
// to run execute: jsdoc -c ./jsdoc.json
// You must remove the comments before adding these options to your .json file
{
"tags": {
"allowUnknownTags": true
},
"source": {
"include": ["./index.js"],
//"exclude": [],
//"includePattern": ".+\\.js(doc)?$",
//"excludePattern": "(^|\\/|\\\\)_",
"_":""
},
"plugins": [],
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"_":""
},
"opts": {
//"template": "templates/default", // same as -t templates/default
//"encoding": "utf8", // same as -e utf8
"destination": "./docs/", // same as -d ./out/
//"recurse": true, // same as -r
"tutorials": "./examples", // same as -u path/to/tutorials, default "" (no tutorials)
//"query": "value", // same as -q value, default "" (no query)
//"private": true, // same as -p
//"lenient": true, // same as -l
// these can also be included, though you probably wouldn't bother
// putting these in conf.json rather than the command line as they cause
// JSDoc not to produce documentation.
//"version": true, // same as --version or -v
//"explain": true, // same as -X
//"test": true, // same as -T
//"help": true, // same as --help or -h
//"verbose": true, // same as --verbose, only relevant to tests.
//"match": "value", // same as --match value, only relevant to tests.
//"nocolor": true, // same as --nocolor, only relevant to tests
"_":""
}
}