44 * Adds shared options to any command that runs documentation
55 */
66module . exports . sharedInputOptions = {
7- strict : true ,
87 shallow : {
98 describe :
109 'shallow mode turns off dependency resolution, ' +
11- 'only processing the specified files (or the main script specified in package.json)' ,
10+ 'only processing the specified files (or the main script specified in package.json)' ,
1211 default : false ,
1312 type : 'boolean'
1413 } ,
@@ -27,13 +26,13 @@ module.exports.sharedInputOptions = {
2726 external : {
2827 describe :
2928 'a string / glob match pattern that defines which external ' +
30- 'modules will be whitelisted and included in the generated documentation.' ,
29+ 'modules will be whitelisted and included in the generated documentation.' ,
3130 default : null
3231 } ,
3332 'require-extension' : {
3433 describe :
3534 "additional extensions to include in require() and import's search algorithm." +
36- 'For instance, adding .es5 would allow require("adder") to find "adder.es5"' ,
35+ 'For instance, adding .es5 would allow require("adder") to find "adder.es5"' ,
3736 // Ensure that the value is an array
3837 coerce : ( value : string | Array < string > ) => [ ] . concat ( value ) ,
3938 alias : 're'
@@ -53,8 +52,8 @@ module.exports.sharedInputOptions = {
5352 access : {
5453 describe :
5554 'Include only comments with a given access level, out of private, ' +
56- 'protected, public, undefined. By default, public, protected, and undefined access ' +
57- 'levels are included' ,
55+ 'protected, public, undefined. By default, public, protected, and undefined access ' +
56+ 'levels are included' ,
5857 choices : [ 'public' , 'private' , 'protected' , 'undefined' ] ,
5958 array : true ,
6059 alias : 'a'
@@ -68,13 +67,13 @@ module.exports.sharedInputOptions = {
6867 type : 'string' ,
6968 describe :
7069 'Infer private access based on the name. This is a regular expression that ' +
71- 'is used to match the name'
70+ 'is used to match the name'
7271 } ,
7372 'document-exported' : {
7473 type : 'boolean' ,
7574 describe :
7675 'Generate documentation for all exported bindings and members ' +
77- 'even if there is no JSDoc for them' ,
76+ 'even if there is no JSDoc for them' ,
7877 default : false
7978 } ,
8079 'sort-order' : {
0 commit comments