Skip to content

Commit a3b88ff

Browse files
committed
update examples
1 parent fe2c786 commit a3b88ff

File tree

4 files changed

+19
-18
lines changed

4 files changed

+19
-18
lines changed

example/explain-source.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
import jsdoc from 'jsdoc-api'
2-
import util from 'node:util'
3-
util.inspect.defaultOptions.depth = 6
4-
util.inspect.defaultOptions.breakLength = process.stdout.columns
5-
util.inspect.defaultOptions.maxArrayLength = Infinity
62

73
const data = await jsdoc.explain({ source: '/** example doclet */ \n var example = true' })
84
console.log(data)

example/explain.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
import jsdoc from 'jsdoc-api'
2-
import util from 'node:util'
3-
util.inspect.defaultOptions.depth = 6
4-
util.inspect.defaultOptions.breakLength = process.stdout.columns
5-
util.inspect.defaultOptions.maxArrayLength = Infinity
62

73
const data = await jsdoc.explain({ files: process.argv.slice(2), cache: true })
84
console.log(data)

example/using-config-explain.js

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
import jsdoc from 'jsdoc-api'
2-
import util from 'node:util'
3-
util.inspect.defaultOptions.depth = 6
4-
util.inspect.defaultOptions.breakLength = process.stdout.columns
5-
util.inspect.defaultOptions.maxArrayLength = Infinity
62

73
const data = await jsdoc.explain({ cache: true, configure: './example/using-config.json' })
84
console.log(data)
5+
6+
/*
7+
The `using-config.json` file looks like this:
8+
9+
{
10+
"source": {
11+
"include": [ "example/using-config-input.js" ]
12+
},
13+
"opts": {
14+
"destination": "./config-out/"
15+
}
16+
}
17+
*/

example/using-config.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"source": {
3-
"include": [ "example/using-config-input.js" ]
4-
},
5-
"opts": {
6-
"destination": "./config-out/"
7-
}
2+
"source": {
3+
"include": [ "example/using-config-input.js" ]
4+
},
5+
"opts": {
6+
"destination": "./config-out/"
7+
}
88
}

0 commit comments

Comments
 (0)