mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
3da1ff6dd0
* Source-sorting by default Many changes * Uses a new version of module-deps that exposes a sort key we use to sort documentation. * Adds inference for methods in objects * Groups events into a separate comment property * Add jsdoc property. Refs https://github.com/documentationjs/documentation/pull/388#issuecomment-215791547 * Namespaces and paths * More powerful paths: paths now include name, kind, and scope * comments now include a 'namespace' property with a formatted namespace * Fix tests * Re-ignore fonts * Nix sourceKey from output * Pin dependency versions * Fix module-deps-sortable ref * Update tests for right deps
183 lines
3.7 KiB
JSON
183 lines
3.7 KiB
JSON
[
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This function has a lot of metadata",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 36,
|
|
"offset": 35
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 36,
|
|
"offset": 35
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 36,
|
|
"offset": 35
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "version",
|
|
"description": "1.2.0",
|
|
"lineNumber": 2
|
|
},
|
|
{
|
|
"title": "author",
|
|
"description": "Jim Jones",
|
|
"lineNumber": 3
|
|
},
|
|
{
|
|
"title": "copyright",
|
|
"description": "John Jones",
|
|
"lineNumber": 4
|
|
},
|
|
{
|
|
"title": "since",
|
|
"description": "1962",
|
|
"lineNumber": 5
|
|
},
|
|
{
|
|
"title": "license",
|
|
"description": "Public Domain",
|
|
"lineNumber": 6
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 8,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 9,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 11,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "/**\n * This function has a lot of metadata\n * @version 1.2.0\n * @author Jim Jones\n * @copyright John Jones\n * @since 1962\n * @license Public Domain\n */\nfunction dewey(a) {\n return a;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"version": "1.2.0",
|
|
"author": "Jim Jones",
|
|
"copyright": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "John Jones",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 11,
|
|
"offset": 10
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 11,
|
|
"offset": 10
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 11,
|
|
"offset": 10
|
|
}
|
|
}
|
|
},
|
|
"since": "1962",
|
|
"license": "Public Domain",
|
|
"name": "dewey",
|
|
"kind": "function",
|
|
"params": [
|
|
{
|
|
"title": "param",
|
|
"name": "a",
|
|
"lineNumber": 9
|
|
}
|
|
],
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
{
|
|
"name": "dewey",
|
|
"kind": "function"
|
|
}
|
|
],
|
|
"namespace": "dewey"
|
|
}
|
|
] |