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
documentation/test/fixture/flow-types.output.md.json
Tom MacWright d069b6a40b Support new node versions, including v4 and v5 
* Compare strings as lowercase, to permit for v4+ compatibility
* Fix bad reference to loc.name
* Update README badge and fixture
* Remove brfs dependency
* Remove traverse
* Remove browser transform support
2015-12-01 15:34:50 -05:00

907 lines
21 KiB
JSON
Raw Blame History

{
"type": "root",
"children": [
{
"depth": 1,
"type": "heading",
"children": [
{
"type": "text",
"value": "addThem"
}
]
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "This function returns the number one.",
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 38
},
"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": "Point"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "b"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "string"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "c"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "[boolean]"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "d"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Array<number>"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "e"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Object"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "f"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Named"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
}
]
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Returns "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "number"
}
]
},
{
"type": "text",
"value": " "
}
]
},
{
"depth": 1,
"type": "heading",
"children": [
{
"type": "text",
"value": "Point"
}
]
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A 2D point.",
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 12
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 12
},
"indent": []
}
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Properties"
}
]
},
{
"ordered": false,
"type": "list",
"children": [
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "x"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "number"
}
]
},
{
"type": "text",
"value": " "
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "this is a prop",
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 15
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 15
},
"indent": []
}
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "y"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "number"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "rgb"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Object"
}
]
},
{
"type": "text",
"value": " "
}
]
},
{
"ordered": false,
"type": "list",
"children": [
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "rgb.hex"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "string"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "props"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Object"
}
]
},
{
"type": "text",
"value": " "
}
]
},
{
"ordered": false,
"type": "list",
"children": [
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "props.radius"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Object"
}
]
},
{
"type": "text",
"value": " "
}
]
},
{
"ordered": false,
"type": "list",
"children": [
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "props.radius.x"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "number"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
}
]
}
]
}
]
}
]
}
]
},
{
"depth": 1,
"type": "heading",
"children": [
{
"type": "text",
"value": "T"
}
]
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Just an alias for an array of strings",
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 38
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 38
},
"indent": []
}
},
{
"depth": 1,
"type": "heading",
"children": [
{
"type": "text",
"value": "Two"
}
]
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "A type with entirely derived properties",
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 40
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 40
},
"indent": []
}
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Properties"
}
]
},
{
"ordered": false,
"type": "list",
"children": [
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "x"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "number"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "y"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "number"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
}
]
},
{
"depth": 1,
"type": "heading",
"children": [
{
"type": "text",
"value": "veryImportantTransform"
}
]
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Very Important Transform",
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 25
},
"indent": []
}
}
],
"position": {
"start": {
"line": 1,
"column": 1
},
"end": {
"line": 1,
"column": 25
},
"indent": []
}
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Parameters"
}
]
},
{
"ordered": false,
"type": "list",
"children": [
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "input"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "Array<string>"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
},
{
"type": "listItem",
"children": [
{
"type": "paragraph",
"children": [
{
"type": "inlineCode",
"value": "options"
},
{
"type": "text",
"value": " "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "[Object]"
}
]
},
{
"type": "text",
"value": " "
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": " (optional, default "
},
{
"type": "inlineCode",
"value": "{}"
},
{
"type": "text",
"value": ")"
}
]
}
]
}
]
}
]
},
{
"type": "paragraph",
"children": [
{
"type": "text",
"value": "Returns "
},
{
"type": "strong",
"children": [
{
"type": "text",
"value": "string"
}
]
},
{
"type": "text",
"value": " "
}
]
}
]
}
Reference in New Issue View Git Blame Copy Permalink