mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
8cc34b661f
* fix(scopes): Support inner scope The purpose and usage of inner is still unclear, unfortunately, so this is an interim fix at best. Fixes https://github.com/documentationjs/documentation/issues/652 * Improve comment typedef while we're at it
669 lines
15 KiB
JSON
669 lines
15 KiB
JSON
[
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 21,
|
|
"offset": 20
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": "the input",
|
|
"lineNumber": 2,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "a"
|
|
},
|
|
{
|
|
"title": "returns",
|
|
"description": "the output",
|
|
"lineNumber": 3,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 5,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 6,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 8,
|
|
"column": 1
|
|
}
|
|
}
|
|
},
|
|
"augments": [],
|
|
"errors": [],
|
|
"examples": [],
|
|
"params": [
|
|
{
|
|
"title": "param",
|
|
"name": "a",
|
|
"lineNumber": 2,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"properties": [],
|
|
"returns": [
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 11,
|
|
"offset": 10
|
|
}
|
|
}
|
|
},
|
|
"title": "returns",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"sees": [],
|
|
"throws": [],
|
|
"todos": [],
|
|
"name": "addOne",
|
|
"kind": "function",
|
|
"members": {
|
|
"global": [],
|
|
"inner": [],
|
|
"instance": [],
|
|
"events": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
{
|
|
"name": "addOne",
|
|
"kind": "function"
|
|
}
|
|
],
|
|
"namespace": "addOne"
|
|
},
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 6,
|
|
"column": 45,
|
|
"offset": 261
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": "the input",
|
|
"lineNumber": 8,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "a"
|
|
},
|
|
{
|
|
"title": "returns",
|
|
"description": "numberone",
|
|
"lineNumber": 9,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 10,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 20,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 21,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 23,
|
|
"column": 2
|
|
}
|
|
}
|
|
},
|
|
"augments": [],
|
|
"errors": [],
|
|
"examples": [],
|
|
"params": [
|
|
{
|
|
"title": "param",
|
|
"name": "a",
|
|
"lineNumber": 8,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"properties": [],
|
|
"returns": [
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10,
|
|
"offset": 9
|
|
}
|
|
}
|
|
},
|
|
"title": "returns",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"sees": [],
|
|
"throws": [],
|
|
"todos": [],
|
|
"name": "inline-link.input",
|
|
"kind": "function",
|
|
"members": {
|
|
"global": [],
|
|
"inner": [],
|
|
"instance": [],
|
|
"events": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
{
|
|
"name": "inline-link.input",
|
|
"kind": "function"
|
|
}
|
|
],
|
|
"namespace": "inline-link.input"
|
|
}
|
|
] |