Skip to content

Commit 813dfbb

Browse files
tmcwtmcw
authoredDec 28, 2016
docs(nodeapi): Fix node API documentation: formatters call (err, res) (#643)
Fixes #642
1 parent 3b26b9c commit 813dfbb

File tree

4 files changed

+30
-29
lines changed

4 files changed

+30
-29
lines changed
 

‎docs/NODE_API.md

+27-26
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,23 @@ comments, given a root file as a path.
1212
- `options.external` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** a string regex / glob match pattern
1313
that defines what external modules will be whitelisted and included in the
1414
generated documentation.
15-
- `options.polyglot` **\[[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** parse comments with a regex rather than
15+
- `options.polyglot` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** parse comments with a regex rather than
1616
a proper parser. This enables support of non-JavaScript languages but
1717
reduces documentation's ability to infer structure of code. (optional, default `false`)
18-
- `options.shallow` **\[[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** whether to avoid dependency parsing
18+
- `options.shallow` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** whether to avoid dependency parsing
1919
even in JavaScript code. With the polyglot option set, this has no effect. (optional, default `false`)
20-
- `options.order` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))>]** optional array that
20+
- `options.order` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))>?** optional array that
2121
defines sorting order of documentation (optional, default `[]`)
22-
- `options.access` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>]** an array of access levels
22+
- `options.access` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>?** an array of access levels
2323
to output in documentation (optional, default `[]`)
24-
- `options.hljs` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** hljs optional options
25-
- `options.hljs.highlightAuto` **\[[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** hljs automatically detect language (optional, default `false`)
26-
- `options.hljs.languages` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** languages for hljs to choose from
27-
- `options.inferPrivate` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** a valid regular expression string
24+
- `options.hljs` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** hljs optional options
25+
- `options.hljs.highlightAuto` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** hljs automatically detect language (optional, default `false`)
26+
- `options.hljs.languages` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)?** languages for hljs to choose from
27+
- `options.inferPrivate` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** a valid regular expression string
2828
to infer whether a code element should be private, given its naming structure.
2929
For instance, you can specify `inferPrivate: '^_'` to automatically treat
3030
methods named like `_myMethod` as private.
31-
- `options.extension` **\[([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>)]** treat additional file extensions
31+
- `options.extension` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>)?** treat additional file extensions
3232
as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
3333
- `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** to be called when the documentation generation
3434
is complete, with (err, result) argumentsj
@@ -67,24 +67,25 @@ synchronously, rather than by calling a callback.
6767
- `options.external` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** a string regex / glob match pattern
6868
that defines what external modules will be whitelisted and included in the
6969
generated documentation.
70-
- `options.polyglot` **\[[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** parse comments with a regex rather than
70+
- `options.polyglot` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** parse comments with a regex rather than
7171
a proper parser. This enables support of non-JavaScript languages but
7272
reduces documentation's ability to infer structure of code. (optional, default `false`)
73-
- `options.shallow` **\[[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** whether to avoid dependency parsing
73+
- `options.shallow` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** whether to avoid dependency parsing
7474
even in JavaScript code. With the polyglot option set, this has no effect. (optional, default `false`)
75-
- `options.order` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))>]** optional array that
75+
- `options.order` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object))>?** optional array that
7676
defines sorting order of documentation (optional, default `[]`)
77-
- `options.access` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>]** an array of access levels
77+
- `options.access` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>?** an array of access levels
7878
to output in documentation (optional, default `[]`)
79-
- `options.hljs` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** hljs optional options
80-
- `options.hljs.highlightAuto` **\[[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** hljs automatically detect language (optional, default `false`)
81-
- `options.hljs.languages` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** languages for hljs to choose from
82-
- `options.inferPrivate` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** a valid regular expression string
79+
- `options.hljs` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)?** hljs optional options
80+
- `options.hljs.highlightAuto` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** hljs automatically detect language (optional, default `false`)
81+
- `options.hljs.languages` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)?** languages for hljs to choose from
82+
- `options.inferPrivate` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** a valid regular expression string
8383
to infer whether a code element should be private, given its naming structure.
8484
For instance, you can specify `inferPrivate: '^_'` to automatically treat
8585
methods named like `_myMethod` as private.
86-
- `options.extension` **\[([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>)]** treat additional file extensions
86+
- `options.extension` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>)?** treat additional file extensions
8787
as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
88+
- `config` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** path to configuration file to load
8889

8990
**Examples**
9091

@@ -112,16 +113,16 @@ of lint information intended for human-readable output.
112113
- `options.external` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>** a string regex / glob match pattern
113114
that defines what external modules will be whitelisted and included in the
114115
generated documentation.
115-
- `options.polyglot` **\[[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** parse comments with a regex rather than
116+
- `options.polyglot` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** parse comments with a regex rather than
116117
a proper parser. This enables support of non-JavaScript languages but
117118
reduces documentation's ability to infer structure of code. (optional, default `false`)
118-
- `options.shallow` **\[[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)]** whether to avoid dependency parsing
119+
- `options.shallow` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** whether to avoid dependency parsing
119120
even in JavaScript code. With the polyglot option set, this has no effect. (optional, default `false`)
120-
- `options.inferPrivate` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** a valid regular expression string
121+
- `options.inferPrivate` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** a valid regular expression string
121122
to infer whether a code element should be private, given its naming structure.
122123
For instance, you can specify `inferPrivate: '^_'` to automatically treat
123124
methods named like `_myMethod` as private.
124-
- `options.extension` **\[([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>)]** treat additional file extensions
125+
- `options.extension` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)>)?** treat additional file extensions
125126
as JavaScript, extending the default set of `js`, `es6`, and `jsx`.
126127
- `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** to be called when the documentation generation
127128
is complete, with (err, result) arguments
@@ -159,7 +160,7 @@ Formats documentation as HTML.
159160

160161
- `comments` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)>** parsed comments
161162
- `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Options that can customize the output
162-
- `options.theme` **\[[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** Name of a module used for an HTML theme. (optional, default `'default_theme'`)
163+
- `options.theme` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** Name of a module used for an HTML theme. (optional, default `'default_theme'`)
163164
- `callback` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** Called with array of results as vinyl-fs objects.
164165

165166
**Examples**
@@ -170,7 +171,7 @@ var streamArray = require('stream-array');
170171
var vfs = require('vinyl-fs');
171172

172173
documentation.build(['index.js'], {}, function (err, res) {
173-
documentation.formats.html(res, {}, function(output) {
174+
documentation.formats.html(res, {}, function(err, output) {
174175
streamArray(output).pipe(vfs.dest('./output-directory'));
175176
});
176177
});
@@ -196,7 +197,7 @@ var documentation = require('documentation');
196197
var fs = require('fs');
197198

198199
documentation.build(['index.js'], {}, function (err, res) {
199-
documentation.formats.md(res, {}, function(output) {
200+
documentation.formats.md(res, {}, function(err, output) {
200201
// output is a string of JSON data
201202
fs.writeFileSync('./output.md', output);
202203
});
@@ -222,7 +223,7 @@ var documentation = require('documentation');
222223
var fs = require('fs');
223224

224225
documentation.build(['index.js'], {}, function (err, res) {
225-
documentation.formats.json(res, {}, function(output) {
226+
documentation.formats.json(res, {}, function(err, output) {
226227
// output is a string of JSON data
227228
fs.writeFileSync('./output.json', output);
228229
});

‎lib/output/html.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var path = require('path');
1818
* var vfs = require('vinyl-fs');
1919
*
2020
* documentation.build(['index.js'], {}, function (err, res) {
21-
* documentation.formats.html(res, {}, function(output) {
21+
* documentation.formats.html(res, {}, function(err, output) {
2222
* streamArray(output).pipe(vfs.dest('./output-directory'));
2323
* });
2424
* });

‎lib/output/json.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ var walk = require('../walk');
1616
* var fs = require('fs');
1717
*
1818
* documentation.build(['index.js'], {}, function (err, res) {
19-
* documentation.formats.json(res, {}, function(output) {
19+
* documentation.formats.json(res, {}, function(err, output) {
2020
* // output is a string of JSON data
2121
* fs.writeFileSync('./output.json', output);
2222
* });

‎lib/output/markdown.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ var remark = require('remark'),
1919
* var fs = require('fs');
2020
*
2121
* documentation.build(['index.js'], {}, function (err, res) {
22-
* documentation.formats.md(res, {}, function(output) {
22+
* documentation.formats.md(res, {}, function(err, output) {
2323
* // output is a string of JSON data
2424
* fs.writeFileSync('./output.md', output);
2525
* });

0 commit comments

Comments
 (0)
Please sign in to comment.