File tree Expand file tree Collapse file tree 2 files changed +3
-8
lines changed Expand file tree Collapse file tree 2 files changed +3
-8
lines changed Original file line number Diff line number Diff line change 1
1
'use strict' ;
2
2
3
3
/**
4
- * Formats documentation as
5
- * [Markdown](http://daringfireball.net/projects/markdown/).
4
+ * Formats documentation as a JSON string.
6
5
*
7
6
* @param {Array<Object> } comments parsed comments
8
7
* @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.
11
8
* @param {Function } callback called with null, string
12
- * @name markdown
9
+ * @name json
13
10
* @return {undefined } calls callback
14
11
*/
15
12
module . exports = function ( comments , opts , callback ) {
Original file line number Diff line number Diff line change @@ -9,9 +9,7 @@ var mdast = require('mdast'),
9
9
*
10
10
* @param {Array<Object> } comments parsed comments
11
11
* @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
15
13
* @name markdown
16
14
* @return {undefined } calls callback
17
15
*/
You can’t perform that action at this time.
0 commit comments