documentation/test/fixture/example-caption.output.json

72 lines
1.5 KiB
JSON

[
{
"description": "This function returns the number one.",
"tags": [
{
"title": "returns",
"description": "numberone",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Number"
}
},
{
"title": "example",
"description": "foo(1);",
"lineNumber": 3,
"caption": "demonstrates how to run foo"
}
],
"loc": {
"start": {
"line": 1,
"column": 0
},
"end": {
"line": 6,
"column": 3
}
},
"context": {
"loc": {
"start": {
"line": 7,
"column": 0
},
"end": {
"line": 10,
"column": 1
}
},
"code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n * @example <caption>demonstrates how to run foo</caption>\n * foo(1);\n */\nfunction foo() {\n // this returns 1\n return 1;\n}\n"
},
"errors": [],
"returns": [
{
"title": "returns",
"description": "numberone",
"lineNumber": 2,
"type": {
"type": "NameExpression",
"name": "Number"
}
}
],
"examples": [
{
"description": "foo(1);",
"caption": "demonstrates how to run foo"
}
],
"name": "foo",
"kind": "function",
"members": {
"instance": [],
"static": []
},
"path": [
"foo"
]
}
]