archive-gh-me/documentation
1
0
Fork 0
mirror of https://github.com/documentationjs/documentation.git synced 2026-01-18 14:17:30 +00:00
Code Issues Projects Releases Wiki Activity

fix(cli): Fix error reporting in the CLI

Browse Source
This commit is contained in:
Tom MacWright 2016-12-28 22:19:40 -05:00 committed by Tom MacWright
parent dd9c03a19e
commit 88c8f9a668
60 changed files with 13 additions and 4592 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
bin/documentation.js
View File

@ -13,7 +13,13 @@ var argv = yargs
.command(commands.lint)
.command(commands.readme)
.fail(function (msg, error) {
throw error;
if (error) {
throw error;
} else {
yargs.showHelp('error');
console.error(msg);
return yargs.exit(1);
}
})
.version(function () {
return require('../package').version;

6
lib/commands/build.js
View File

@ -49,7 +49,6 @@ module.exports.builder = extend({},
* just a thin wrapper around this one.
*/
module.exports.handler = function build(argv, callback) {
console.log(argv);
argv._handled = true;
argv = sharedOptions.expandInputs(argv);
if (argv.f === 'html' && argv.o === 'stdout') {
@ -57,7 +56,10 @@ module.exports.handler = function build(argv, callback) {
}
var generator = documentation.build
.bind(null, argv.input, argv, onDocumented); function onDocumented(err, comments) { if (err) {
.bind(null, argv.input, argv, onDocumented);
function onDocumented(err, comments) {
if (err) {
if (typeof callback === 'function') {
return callback(err);
}

4
test/fixture/auto_lang_hljs/multilanguage.output.md
View File

@ -1,9 +1,5 @@
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [multilanguage.input](#multilanguageinput)
## multilanguage.input
**Extends Foo, Bar**

47
test/fixture/boolean-literal-type.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#f",
"children": [
{
"type": "text",
"value": "f"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

7
test/fixture/class.config.output.md
View File

@ -1,12 +1,5 @@
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [MyClass](#myclass)
- [getFoo](#getfoo)
- [getUndefined](#getundefined)
- [Hello](#hello)
## MyClass
This is my class, a demo thing.

97
test/fixture/class.output.md.json
View File

@ -5,103 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#myclass",
"children": [
{
"type": "text",
"value": "MyClass"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#getfoo",
"children": [
{
"type": "text",
"value": "getFoo"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#getundefined",
"children": [
{
"type": "text",
"value": "getUndefined"
}
]
}
]
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

69
test/fixture/document-exported-export-default-object.output.md.json
View File

@ -5,75 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#document-exported-export-default-objectinput",
"children": [
{
"type": "text",
"value": "document-exported-export-default-object.input"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#x",
"children": [
{
"type": "text",
"value": "x"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/document-exported-export-default-value.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#document-exported-export-default-valueinput",
"children": [
{
"type": "text",
"value": "document-exported-export-default-value.input"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

703
test/fixture/document-exported.output.md.json
View File

@ -5,709 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#z",
"children": [
{
"type": "text",
"value": "z"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#zmethod",
"children": [
{
"type": "text",
"value": "zMethod"
}
]
}
]
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#x",
"children": [
{
"type": "text",
"value": "x"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#class",
"children": [
{
"type": "text",
"value": "Class"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#classmethod",
"children": [
{
"type": "text",
"value": "classMethod"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#classgetter",
"children": [
{
"type": "text",
"value": "classGetter"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#classsetter",
"children": [
{
"type": "text",
"value": "classSetter"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#staticmethod",
"children": [
{
"type": "text",
"value": "staticMethod"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#staticgetter",
"children": [
{
"type": "text",
"value": "staticGetter"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#staticsetter",
"children": [
{
"type": "text",
"value": "staticSetter"
}
]
}
]
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#t5",
"children": [
{
"type": "text",
"value": "T5"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#y2default",
"children": [
{
"type": "text",
"value": "y2Default"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#y4",
"children": [
{
"type": "text",
"value": "y4"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#object",
"children": [
{
"type": "text",
"value": "object"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#prop",
"children": [
{
"type": "text",
"value": "prop"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#func",
"children": [
{
"type": "text",
"value": "func"
}
]
}
]
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#method",
"children": [
{
"type": "text",
"value": "method"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#getter",
"children": [
{
"type": "text",
"value": "getter"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#setter",
"children": [
{
"type": "text",
"value": "setter"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#f1",
"children": [
{
"type": "text",
"value": "f1"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#f3",
"children": [
{
"type": "text",
"value": "f3"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#t",
"children": [
{
"type": "text",
"value": "T"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#t2",
"children": [
{
"type": "text",
"value": "T2"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#t4",
"children": [
{
"type": "text",
"value": "T4"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#f4",
"children": [
{
"type": "text",
"value": "f4"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#o1",
"children": [
{
"type": "text",
"value": "o1"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#om1",
"children": [
{
"type": "text",
"value": "om1"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#f5",
"children": [
{
"type": "text",
"value": "f5"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#o2",
"children": [
{
"type": "text",
"value": "o2"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#om2",
"children": [
{
"type": "text",
"value": "om2"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

119
test/fixture/es6-class.output.md.json
View File

@ -5,125 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo",
"children": [
{
"type": "text",
"value": "Foo"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#bar",
"children": [
{
"type": "text",
"value": "Bar"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#constructor",
"children": [
{
"type": "text",
"value": "constructor"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#bar-1",
"children": [
{
"type": "text",
"value": "bar"
}
]
}
]
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/es6-default2.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#es6-default2input",
"children": [
{
"type": "text",
"value": "es6-default2.input"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

91
test/fixture/es6-import.output.md.json
View File

@ -5,97 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#multiplytwice",
"children": [
{
"type": "text",
"value": "multiplyTwice"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#es6-ext",
"children": [
{
"type": "text",
"value": "es6-ext"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#simpleinput",
"children": [
{
"type": "text",
"value": "simple.input"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

471
test/fixture/es6.output.md.json
View File

@ -5,477 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#destructure",
"children": [
{
"type": "text",
"value": "destructure"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#destructure-1",
"children": [
{
"type": "text",
"value": "destructure"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#multiply",
"children": [
{
"type": "text",
"value": "multiply"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#sink",
"children": [
{
"type": "text",
"value": "Sink"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#staticprop",
"children": [
{
"type": "text",
"value": "staticProp"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#empty",
"children": [
{
"type": "text",
"value": "empty"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#agetter",
"children": [
{
"type": "text",
"value": "aGetter"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#constructor",
"children": [
{
"type": "text",
"value": "constructor"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#hello",
"children": [
{
"type": "text",
"value": "hello"
}
]
}
]
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#makeabasket",
"children": [
{
"type": "text",
"value": "makeABasket"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#makeasink",
"children": [
{
"type": "text",
"value": "makeASink"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#functionwithrest",
"children": [
{
"type": "text",
"value": "functionWithRest"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#functionwithrestandtype",
"children": [
{
"type": "text",
"value": "functionWithRestAndType"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo",
"children": [
{
"type": "text",
"value": "foo"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#es6input",
"children": [
{
"type": "text",
"value": "es6.input"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#veryimportanttransform",
"children": [
{
"type": "text",
"value": "veryImportantTransform"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#iamprotected",
"children": [
{
"type": "text",
"value": "iAmProtected"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#iampublic",
"children": [
{
"type": "text",
"value": "iAmPublic"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#execute",
"children": [
{
"type": "text",
"value": "execute"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#isarrayequalwith",
"children": [
{
"type": "text",
"value": "isArrayEqualWith"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/event.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#mapmousemove",
"children": [
{
"type": "text",
"value": "Map#mousemove"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/example-caption.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo",
"children": [
{
"type": "text",
"value": "foo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/external.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo",
"children": [
{
"type": "text",
"value": "foo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

91
test/fixture/factory.output.md.json
View File

@ -5,97 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#area",
"children": [
{
"type": "text",
"value": "area"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#area-1",
"children": [
{
"type": "text",
"value": "area"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#data",
"children": [
{
"type": "text",
"value": "data"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

75
test/fixture/infer-private.output.md.json
View File

@ -5,81 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#c",
"children": [
{
"type": "text",
"value": "C"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#m",
"children": [
{
"type": "text",
"value": "m"
}
]
}
]
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

69
test/fixture/inheritance.output.md.json
View File

@ -5,75 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#specialarray",
"children": [
{
"type": "text",
"value": "SpecialArray"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo",
"children": [
{
"type": "text",
"value": "Foo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

69
test/fixture/inline-link.output.md.json
View File

@ -5,75 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#addone",
"children": [
{
"type": "text",
"value": "addOne"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#inline-linkinput",
"children": [
{
"type": "text",
"value": "inline-link.input"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/internal.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo",
"children": [
{
"type": "text",
"value": "foo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

69
test/fixture/literal_types.output.md.json
View File

@ -5,75 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#f",
"children": [
{
"type": "text",
"value": "f"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#g",
"children": [
{
"type": "text",
"value": "g"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

97
test/fixture/memberedclass.output.md.json
View File

@ -5,103 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#myclass",
"children": [
{
"type": "text",
"value": "MyClass"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#getfoo",
"children": [
{
"type": "text",
"value": "getFoo"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#getundefined",
"children": [
{
"type": "text",
"value": "getUndefined"
}
]
}
]
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/merge-infered-type.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#addfive",
"children": [
{
"type": "text",
"value": "addFive"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

69
test/fixture/multisignature.output.md.json
View File

@ -5,75 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#getthetime",
"children": [
{
"type": "text",
"value": "getTheTime"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#getthetime-1",
"children": [
{
"type": "text",
"value": "getTheTime"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/nearby_params.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#sessionscreate",
"children": [
{
"type": "text",
"value": "sessions.create"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

69
test/fixture/nest_params.output.md.json
View File

@ -5,75 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo",
"children": [
{
"type": "text",
"value": "foo"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo-1",
"children": [
{
"type": "text",
"value": "foo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

19
test/fixture/newline-in-description.output.md.json
View File

@ -5,25 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"depth": 2,
"type": "heading",

19
test/fixture/no-name.output.md.json
View File

@ -5,25 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"depth": 2,
"type": "heading",

47
test/fixture/optional-record-field-type.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#record",
"children": [
{
"type": "text",
"value": "Record"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

229
test/fixture/params.output.md.json
View File

@ -5,235 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#addthem",
"children": [
{
"type": "text",
"value": "addThem"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#fishesandfoxes",
"children": [
{
"type": "text",
"value": "fishesAndFoxes"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#withdefault",
"children": [
{
"type": "text",
"value": "withDefault"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo",
"children": [
{
"type": "text",
"value": "Foo"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#method",
"children": [
{
"type": "text",
"value": "method"
}
]
}
]
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#address6",
"children": [
{
"type": "text",
"value": "Address6"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#geojsonsource",
"children": [
{
"type": "text",
"value": "GeoJSONSource"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#myfunc",
"children": [
{
"type": "text",
"value": "myfunc"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo-1",
"children": [
{
"type": "text",
"value": "foo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/react-jsx.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#apples",
"children": [
{
"type": "text",
"value": "apples"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

5
test/fixture/readme/README.output.md
View File

@ -4,11 +4,6 @@
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [foo](#foo)
- [bar](#bar)
## foo
A function with documentation.

19
test/fixture/require-json-no-extension.output.md.json
View File

@ -4,25 +4,6 @@
{
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
}
]
}

19
test/fixture/require-json.output.md.json
View File

@ -4,25 +4,6 @@
{
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
}
]
}

47
test/fixture/simple-hashbang.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#simple-hashbanginput",
"children": [
{
"type": "text",
"value": "simple-hashbang.input"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

19
test/fixture/simple-private.output.md.json
View File

@ -4,25 +4,6 @@
{
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
}
]
}

19
test/fixture/simple-singlestar.output.md.json
View File

@ -4,25 +4,6 @@
{
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
}
]
}

19
test/fixture/simple-triplestar.output.md.json
View File

@ -4,25 +4,6 @@
{
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
}
]
}

47
test/fixture/simple-two.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#returntwo",
"children": [
{
"type": "text",
"value": "returnTwo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

4
test/fixture/simple.output.github.md
View File

@ -1,9 +1,5 @@
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [simple.input](#simpleinput)
## simple.input
[test/fixture/simple.input.js:5-8]([github] "Source code on GitHub")

47
test/fixture/simple.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#simpleinput",
"children": [
{
"type": "text",
"value": "simple.input"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

301
test/fixture/sort-order-alpha.output.md.json
View File

@ -5,307 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#a",
"children": [
{
"type": "text",
"value": "a"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#b",
"children": [
{
"type": "text",
"value": "b"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#c",
"children": [
{
"type": "text",
"value": "C"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#a-1",
"children": [
{
"type": "text",
"value": "A"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#a-2",
"children": [
{
"type": "text",
"value": "a"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#b-1",
"children": [
{
"type": "text",
"value": "B"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#b-2",
"children": [
{
"type": "text",
"value": "b"
}
]
}
]
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#d",
"children": [
{
"type": "text",
"value": "D"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#a-3",
"children": [
{
"type": "text",
"value": "A"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#a-4",
"children": [
{
"type": "text",
"value": "a"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#b-3",
"children": [
{
"type": "text",
"value": "B"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#b-4",
"children": [
{
"type": "text",
"value": "b"
}
]
}
]
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

69
test/fixture/string-literal-key.output.md.json
View File

@ -5,75 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#mycontainerobject",
"children": [
{
"type": "text",
"value": "MyContainerObject"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foo",
"children": [
{
"type": "text",
"value": "foo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/sync/alias.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#nixon",
"children": [
{
"type": "text",
"value": "nixon"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/sync/empty-example.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#returntwo",
"children": [
{
"type": "text",
"value": "returnTwo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

245
test/fixture/sync/flow-types.output.md.json
View File

@ -5,251 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#addthem",
"children": [
{
"type": "text",
"value": "addThem"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#point",
"children": [
{
"type": "text",
"value": "Point"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#two",
"children": [
{
"type": "text",
"value": "Two"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#t",
"children": [
{
"type": "text",
"value": "T"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#t-1",
"children": [
{
"type": "text",
"value": "T"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#veryimportanttransform",
"children": [
{
"type": "text",
"value": "veryImportantTransform"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#optionalfunc",
"children": [
{
"type": "text",
"value": "optionalFunc"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#objectparamfn",
"children": [
{
"type": "text",
"value": "objectParamFn"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#objectparamfn-1",
"children": [
{
"type": "text",
"value": "objectParamFn"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#someobjectapi",
"children": [
{
"type": "text",
"value": "SomeObjectAPI"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/sync/lots-of-options.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#gsd",
"children": [
{
"type": "text",
"value": "gsd"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/sync/meta.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#dewey",
"children": [
{
"type": "text",
"value": "dewey"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/sync/multiexample.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#multiexampleinput",
"children": [
{
"type": "text",
"value": "multiexample.input"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/sync/rename.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#cheese",
"children": [
{
"type": "text",
"value": "cheese"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/sync/throws.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#returntwo",
"children": [
{
"type": "text",
"value": "returnTwo"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

19
test/fixture/sync/trailing-only.output.md.json
View File

@ -5,25 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"depth": 2,
"type": "heading",

91
test/fixture/sync/trailing.output.md.json
View File

@ -5,97 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foobar",
"children": [
{
"type": "text",
"value": "fooBar"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#foobaz",
"children": [
{
"type": "text",
"value": "fooBaz"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#something",
"children": [
{
"type": "text",
"value": "Something"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/sync/typedef.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#mytype",
"children": [
{
"type": "text",
"value": "MyType"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/system-import.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#simpleinput",
"children": [
{
"type": "text",
"value": "simple.input"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

147
test/fixture/this-class.output.md.json
View File

@ -5,153 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#bookshelf",
"children": [
{
"type": "text",
"value": "bookshelf"
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#book",
"children": [
{
"type": "text",
"value": "Book"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#title",
"children": [
{
"type": "text",
"value": "title"
}
]
}
]
}
]
}
]
}
]
},
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#bookshelf-1",
"children": [
{
"type": "text",
"value": "BookShelf"
}
]
}
]
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#title-1",
"children": [
{
"type": "text",
"value": "title"
}
]
}
]
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/type_application.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#address6",
"children": [
{
"type": "text",
"value": "Address6"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

47
test/fixture/var-function-param-return.output.md.json
View File

@ -5,53 +5,6 @@
"type": "html",
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
},
{
"depth": 3,
"type": "heading",
"children": [
{
"type": "text",
"value": "Table of Contents"
}
],
"data": {
"id": "table-of-contents",
"htmlAttributes": {
"id": "table-of-contents"
},
"hProperties": {
"id": "table-of-contents"
}
}
},
{
"type": "list",
"ordered": false,
"children": [
{
"type": "listItem",
"loose": false,
"children": [
{
"type": "paragraph",
"children": [
{
"type": "link",
"title": null,
"url": "#f",
"children": [
{
"type": "text",
"value": "f"
}
]
}
]
}
]
}
]
},
{
"depth": 2,
"type": "heading",

4
test/test.js
View File

@ -143,7 +143,7 @@ test('outputs', function (ttt) {
tt.ifError(err);
tt.test('markdown', function (t) {
outputMarkdown(_.cloneDeep(result), {}, function (err, result) {
outputMarkdown(_.cloneDeep(result), { markdownToc: true }, function (err, result) {
t.ifError(err);
var outputfile = file.replace('.input.js', '.output.md');
if (UPDATE) {
@ -212,7 +212,7 @@ test('outputs - sync', function (ttt) {
var result = documentation.buildSync([file], readOptionsFromFile(file));
tt.test('markdown', function (t) {
outputMarkdown(result, {}, function (err, result) {
outputMarkdown(result, { markdownToc: true }, function (err, result) {
t.ifError(err);
var outputfile = file.replace('.input.js', '.output.md');
if (UPDATE) {