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
128 lines
2.8 KiB
JSON
128 lines
2.8 KiB
JSON
[
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "I am in ",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 9,
|
|
"offset": 8
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "external.input.js",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 9,
|
|
"offset": 8
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 28,
|
|
"offset": 27
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": ".",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 28,
|
|
"offset": 27
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 29,
|
|
"offset": 28
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 29,
|
|
"offset": 28
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 29,
|
|
"offset": 28
|
|
}
|
|
}
|
|
},
|
|
"tags": [],
|
|
"loc": {
|
|
"start": {
|
|
"line": 7,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 9,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 10,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 13,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "require('external');\nrequire('external2');\nrequire('module-not-found');\n// non-js require\nrequire('./polyglot/blend.cpp');\n\n/**\n * I am in `external.input.js`.\n */\nfunction foo() {\n 'use strict';\n return 'bar';\n}\n\nmodule.exports = foo;\n"
|
|
},
|
|
"errors": [],
|
|
"name": "foo",
|
|
"kind": "function",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
{
|
|
"name": "foo",
|
|
"kind": "function"
|
|
}
|
|
],
|
|
"namespace": "foo"
|
|
}
|
|
] |