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
163 lines
3.2 KiB
JSON
163 lines
3.2 KiB
JSON
[
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "With ES6, built-in types are extensible!",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 41,
|
|
"offset": 40
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 41,
|
|
"offset": 40
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 41,
|
|
"offset": 40
|
|
}
|
|
}
|
|
},
|
|
"tags": [],
|
|
"loc": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 4,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 7,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "/**\n * With ES6, built-in types are extensible!\n */\nclass SpecialArray extends Array {\n additionalMethod() {\n }\n}\n\n/** @class Foo */\nmodule.exports = class Foo extends Bar { };\n"
|
|
},
|
|
"errors": [],
|
|
"name": "SpecialArray",
|
|
"augments": [
|
|
{
|
|
"title": "augments",
|
|
"name": "Array"
|
|
}
|
|
],
|
|
"kind": "class",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
{
|
|
"name": "SpecialArray",
|
|
"kind": "class"
|
|
}
|
|
],
|
|
"namespace": "SpecialArray"
|
|
},
|
|
{
|
|
"description": "",
|
|
"tags": [
|
|
{
|
|
"title": "class",
|
|
"description": null,
|
|
"lineNumber": 0,
|
|
"type": null,
|
|
"name": "Foo"
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 9,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 9,
|
|
"column": 17
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 10,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 10,
|
|
"column": 43
|
|
}
|
|
},
|
|
"code": "/**\n * With ES6, built-in types are extensible!\n */\nclass SpecialArray extends Array {\n additionalMethod() {\n }\n}\n\n/** @class Foo */\nmodule.exports = class Foo extends Bar { };\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"message": "@memberof reference to module not found",
|
|
"commentLineNumber": 0
|
|
}
|
|
],
|
|
"kind": "class",
|
|
"name": "Foo",
|
|
"augments": [
|
|
{
|
|
"title": "augments",
|
|
"name": "Bar"
|
|
}
|
|
],
|
|
"memberof": "module",
|
|
"scope": "static",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
{
|
|
"name": "Foo",
|
|
"kind": "class",
|
|
"scope": "static"
|
|
}
|
|
],
|
|
"namespace": ".Foo"
|
|
}
|
|
] |