mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
84f09f9953
Can now infer * function * constant * class Remove unused var and inapplicable comment Use strict, use a string to run functions not legal in strict mode Make output fancier and better. Use difflet, channel rage Normalize html / json output Omit json from test output Fixup output
132 lines
2.6 KiB
JSON
132 lines
2.6 KiB
JSON
[
|
|
{
|
|
"description": "This function returns the number one.",
|
|
"tags": [
|
|
{
|
|
"title": "returns",
|
|
"description": "numberone",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Number"
|
|
}
|
|
},
|
|
{
|
|
"title": "name",
|
|
"name": "exports"
|
|
},
|
|
{
|
|
"title": "kind",
|
|
"kind": "function"
|
|
},
|
|
{
|
|
"title": "memberof",
|
|
"description": "module"
|
|
},
|
|
{
|
|
"title": "static"
|
|
}
|
|
],
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 5,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 8,
|
|
"column": 2
|
|
}
|
|
},
|
|
"file": "fixture/simple.input.js",
|
|
"code": "module.exports = function () {\n // this returns 1\n return 1;\n};"
|
|
},
|
|
"returns": [
|
|
{
|
|
"title": "returns",
|
|
"description": "numberone",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Number"
|
|
}
|
|
}
|
|
],
|
|
"name": "exports",
|
|
"kind": "function",
|
|
"memberof": "module",
|
|
"scope": "static"
|
|
},
|
|
{
|
|
"description": "This function returns the number plus two.",
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": "the number",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Number"
|
|
},
|
|
"name": "a"
|
|
},
|
|
{
|
|
"title": "returns",
|
|
"description": "numbertwo",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Number"
|
|
}
|
|
},
|
|
{
|
|
"title": "example",
|
|
"description": "var result = returnTwo(4);\n// result is 6"
|
|
},
|
|
{
|
|
"title": "name",
|
|
"name": "returnTwo"
|
|
},
|
|
{
|
|
"title": "kind",
|
|
"kind": "function"
|
|
}
|
|
],
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 10,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 13,
|
|
"column": 1
|
|
}
|
|
},
|
|
"file": "fixture/simple-two.input.js",
|
|
"code": "function returnTwo(a) {\n // this returns a + 2\n return a + 2;\n}"
|
|
},
|
|
"params": [
|
|
{
|
|
"title": "param",
|
|
"description": "the number",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Number"
|
|
},
|
|
"name": "a"
|
|
}
|
|
],
|
|
"returns": [
|
|
{
|
|
"title": "returns",
|
|
"description": "numbertwo",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Number"
|
|
}
|
|
}
|
|
],
|
|
"examples": [
|
|
"var result = returnTwo(4);\n// result is 6"
|
|
],
|
|
"name": "returnTwo",
|
|
"kind": "function"
|
|
}
|
|
] |