mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
08d6dc21bd
This eliminates the need for formatInlineTags and jsdoc-inline-lex, and simplifies the implementation of HTML themes.
730 lines
18 KiB
JSON
730 lines
18 KiB
JSON
[
|
|
{
|
|
"description": "",
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": "The employees who are responsible for the project.",
|
|
"lineNumber": 1,
|
|
"type": {
|
|
"type": "TypeApplication",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "Array"
|
|
},
|
|
"applications": [
|
|
{
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
}
|
|
]
|
|
},
|
|
"name": "employees"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "The name of an employee.",
|
|
"lineNumber": 2,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "string"
|
|
},
|
|
"name": "employees[].name"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "The employee's department.",
|
|
"lineNumber": 3,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "string"
|
|
},
|
|
"name": "employees[].department"
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 5,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 6,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 7,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "/**\n * @param {Object[]} employees - The employees who are responsible for the project.\n * @param {string} employees[].name - The name of an employee.\n * @param {string} employees[].department - The employee's department.\n */\nfunction foo(employee) {\n}\n\n/**\n * @name foo\n * @param {Object} options some options\n * @param {number} options.much how much\n * @param {number} bar something else\n * @property {Object} theTime the current time\n * @property {number} theTime.hours\n * @property {number} theTime.minutes\n * @property {number} theTime.seconds\n * @returns {Object} foo something else\n */\n"
|
|
},
|
|
"errors": [],
|
|
"params": [
|
|
{
|
|
"name": "employees",
|
|
"lineNumber": 1,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "The employees who are responsible for the project.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 51,
|
|
"offset": 50
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 51,
|
|
"offset": 50
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 51,
|
|
"offset": 50
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "TypeApplication",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "Array"
|
|
},
|
|
"applications": [
|
|
{
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
}
|
|
]
|
|
},
|
|
"properties": [
|
|
{
|
|
"name": "employees[].name",
|
|
"lineNumber": 2,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "The name of an employee.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 25,
|
|
"offset": 24
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 25,
|
|
"offset": 24
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 25,
|
|
"offset": 24
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "employees[].department",
|
|
"lineNumber": 3,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "The employee's department.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 27,
|
|
"offset": 26
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 27,
|
|
"offset": 26
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 27,
|
|
"offset": 26
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "string"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"title": "param",
|
|
"name": "employee",
|
|
"lineNumber": 6
|
|
}
|
|
],
|
|
"name": "foo",
|
|
"kind": "function",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"foo"
|
|
]
|
|
},
|
|
{
|
|
"description": "",
|
|
"tags": [
|
|
{
|
|
"title": "name",
|
|
"description": null,
|
|
"lineNumber": 1,
|
|
"name": "foo"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "some options",
|
|
"lineNumber": 2,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
},
|
|
"name": "options"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "how much",
|
|
"lineNumber": 3,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "options.much"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "something else",
|
|
"lineNumber": 4,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "bar"
|
|
},
|
|
{
|
|
"title": "property",
|
|
"description": "the current time",
|
|
"lineNumber": 5,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
},
|
|
"name": "theTime"
|
|
},
|
|
{
|
|
"title": "property",
|
|
"description": null,
|
|
"lineNumber": 6,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "theTime.hours"
|
|
},
|
|
{
|
|
"title": "property",
|
|
"description": null,
|
|
"lineNumber": 7,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "theTime.minutes"
|
|
},
|
|
{
|
|
"title": "property",
|
|
"description": null,
|
|
"lineNumber": 8,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "theTime.seconds"
|
|
},
|
|
{
|
|
"title": "returns",
|
|
"description": "foo something else",
|
|
"lineNumber": 9,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
}
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 9,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 19,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 6,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 7,
|
|
"column": 1
|
|
}
|
|
}
|
|
},
|
|
"errors": [],
|
|
"name": "foo",
|
|
"params": [
|
|
{
|
|
"name": "options",
|
|
"lineNumber": 2,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "some options",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 13,
|
|
"offset": 12
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 13,
|
|
"offset": 12
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 13,
|
|
"offset": 12
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
},
|
|
"properties": [
|
|
{
|
|
"name": "options.much",
|
|
"lineNumber": 3,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "how much",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 9,
|
|
"offset": 8
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 9,
|
|
"offset": 8
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 9,
|
|
"offset": 8
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "bar",
|
|
"lineNumber": 4,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "something else",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 15,
|
|
"offset": 14
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 15,
|
|
"offset": 14
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 15,
|
|
"offset": 14
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"properties": [
|
|
{
|
|
"name": "theTime",
|
|
"lineNumber": 5,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "the current time",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 17,
|
|
"offset": 16
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 17,
|
|
"offset": 16
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 17,
|
|
"offset": 16
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
},
|
|
"properties": [
|
|
{
|
|
"name": "theTime.hours",
|
|
"lineNumber": 6,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"name": "theTime.minutes",
|
|
"lineNumber": 7,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
},
|
|
{
|
|
"name": "theTime.seconds",
|
|
"lineNumber": 8,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returns": [
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "foo something else",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 19,
|
|
"offset": 18
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 19,
|
|
"offset": 18
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 19,
|
|
"offset": 18
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
}
|
|
}
|
|
],
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"foo"
|
|
]
|
|
}
|
|
] |