Skip to content

Commit 9822f75

Browse files
committed
Fix output documentation
1 parent 9dcfa84 commit 9822f75

File tree

2 files changed

+3
-8
lines changed

2 files changed

+3
-8
lines changed

lib/output/json.js

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
'use strict';
22

33
/**
4-
* Formats documentation as
5-
* [Markdown](http://daringfireball.net/projects/markdown/).
4+
* Formats documentation as a JSON string.
65
*
76
* @param {Array<Object>} comments parsed comments
87
* @param {Object} opts Options that can customize the output
9-
* @param {string} [opts.template='../../share/markdown.hbs'] Path to a Handlebars template file that
10-
* takes the place of the default.
118
* @param {Function} callback called with null, string
12-
* @name markdown
9+
* @name json
1310
* @return {undefined} calls callback
1411
*/
1512
module.exports = function (comments, opts, callback) {

lib/output/markdown.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,7 @@ var mdast = require('mdast'),
99
*
1010
* @param {Array<Object>} comments parsed comments
1111
* @param {Object} opts Options that can customize the output
12-
* @param {string} [opts.template='../../share/markdown.hbs'] Path to a Handlebars template file that
13-
* takes the place of the default.
14-
* @param {Function} callback called with array of results as vinyl-fs objects
12+
* @param {Function} callback called with null, string
1513
* @name markdown
1614
* @return {undefined} calls callback
1715
*/

0 commit comments

Comments
 (0)