Skip to content

Commit f4b8f1e

Browse files
committed
update JSDoc
provide documentation about the extra optional param
1 parent 4094275 commit f4b8f1e

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ var through2 = require('through2'),
88
* @param {Object} options output options
99
* @param {string} options.format either 'html', 'md', 'json', or 'docset'
1010
* @param {string} options.filename custom filename for md or json output
11+
* @param {Object} [documentation] your custom instance of documentation.js
1112
* @returns {stream.Transform}
1213
* @example
1314
* var documentation = require('./'),

0 commit comments

Comments
 (0)