mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
631c6925d4
* feat(core): Switch to Promises everywhere. Adopt Node v4 ES6 Big changes: * Uses template strings where appropriate * Config and argument parsing is unified and there is no such thing as formatterOptions anymore. All user-passed options go through mergeConfig. * The node API surface changed (again): `buildSync` is removed, building operations return Promises. * Now using Flow for internal type annotations. More changes: * Remove buildSync command * feat(inference): Partially implement object shorthand support * Refs #649 * Use Flow annotations to enforce types * Keep flow but switch to comment syntax * Clarify types * More flow improvements * Turn server into class * LinkerStack becomes class too * Fix comment description type * Run flow on lint * Many more flow fixes * More intense flow refactoring * Simplify inference steps * Update inference tests, flow errors down to 1 * Continue refining types * Fix more flow issues * Use 'use strict' everywhere * Make 'ast' property configurable * Fix many tests * Fix more tests * Fix more tests * Fix augments * Test Markdown meta support * Improve test coverage * Switch back from for of to for for speed
582 lines
14 KiB
JSON
582 lines
14 KiB
JSON
{
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "html",
|
|
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
|
|
},
|
|
{
|
|
"depth": 2,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "addOne"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Adds one to a number",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 21,
|
|
"offset": 20
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 21,
|
|
"offset": 20
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "a"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "the input",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Returns "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "the output",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 11,
|
|
"offset": 10
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 11,
|
|
"offset": 10
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"depth": 2,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "inline-link.input"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This function returns the number one. Internally, this uses\n",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 1,
|
|
"offset": 60
|
|
},
|
|
"indent": [
|
|
1
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "link",
|
|
"url": "#addone",
|
|
"title": null,
|
|
"jsdoc": true,
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "addOne"
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 2,
|
|
"column": 1,
|
|
"offset": 60
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 15,
|
|
"offset": 74
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " to do the math. This demonstrates\n",
|
|
"position": {
|
|
"start": {
|
|
"line": 2,
|
|
"column": 15,
|
|
"offset": 74
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 1,
|
|
"offset": 109
|
|
},
|
|
"indent": [
|
|
1
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "link",
|
|
"url": "https://en.wikipedia.org/wiki/Addition",
|
|
"title": null,
|
|
"jsdoc": true,
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Addition"
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 3,
|
|
"column": 1,
|
|
"offset": 109
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 56,
|
|
"offset": 164
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "\nand ",
|
|
"position": {
|
|
"start": {
|
|
"line": 3,
|
|
"column": 56,
|
|
"offset": 164
|
|
},
|
|
"end": {
|
|
"line": 4,
|
|
"column": 5,
|
|
"offset": 169
|
|
},
|
|
"indent": [
|
|
1
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "link",
|
|
"url": "https://en.wikipedia.org/wiki/Addition",
|
|
"title": null,
|
|
"jsdoc": true,
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "https://en.wikipedia.org/wiki/Addition"
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 4,
|
|
"column": 5,
|
|
"offset": 169
|
|
},
|
|
"end": {
|
|
"line": 4,
|
|
"column": 51,
|
|
"offset": 215
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 4,
|
|
"column": 51,
|
|
"offset": 215
|
|
},
|
|
"indent": [
|
|
1,
|
|
1,
|
|
1
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This link refers to nothing: ",
|
|
"position": {
|
|
"start": {
|
|
"line": 6,
|
|
"column": 1,
|
|
"offset": 217
|
|
},
|
|
"end": {
|
|
"line": 6,
|
|
"column": 30,
|
|
"offset": 246
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "link",
|
|
"url": "nothing",
|
|
"title": null,
|
|
"jsdoc": true,
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "nothing"
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 6,
|
|
"column": 30,
|
|
"offset": 246
|
|
},
|
|
"end": {
|
|
"line": 6,
|
|
"column": 45,
|
|
"offset": 261
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 6,
|
|
"column": 1,
|
|
"offset": 217
|
|
},
|
|
"end": {
|
|
"line": 6,
|
|
"column": 45,
|
|
"offset": 261
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "a"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "the input",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Returns "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "numberone",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
} |