mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
70cc7d0718
Given the `type` tag introduced with Flow, this can infer a typedef statement, as well as infer its potentially nested properties and their types. This also includes * Refactor of Markdown AST generation that fixes #228 * Refactor of nest.js to handle multi-level nesting
190 lines
4.0 KiB
JSON
190 lines
4.0 KiB
JSON
{
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"depth": 1,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "returnTwo"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This function returns the number plus two.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 43
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 43
|
|
},
|
|
"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": [
|
|
{
|
|
"type": "text",
|
|
"value": "Number"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "the number",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 11
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 11
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Examples"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"lang": "javascript",
|
|
"type": "code",
|
|
"value": "var result = returnTwo(4);\n// result is 6"
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Returns "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Number"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "numbertwo",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 10
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
} |