mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
2109 lines
67 KiB
JSON
2109 lines
67 KiB
JSON
[
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This method has partially inferred params",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 42,
|
|
"offset": 41
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 42,
|
|
"offset": 41
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 42,
|
|
"offset": 41
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": "number of kinds of fish",
|
|
"lineNumber": 2,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "String"
|
|
},
|
|
"name": "$0.fishes"
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 9,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 12,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 13,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 15,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "/**\n * This function returns the number one.\n * @param {number} b the second param\n */\nfunction addThem(a, b, c, { d, e, f }) {\n return a + b + c + d + e + f;\n}\n\n/**\n * This method has partially inferred params\n * @param {String} $0.fishes number of kinds of fish\n */\nfunction fishesAndFoxes({ fishes, foxes }) {\n return fishes + foxes;\n}\n\n/**\n * This method has a type in the description and a default in the code\n * @param {number} x\n */\nfunction withDefault(x = 2) {\n return x;\n}\n\n/**\n * This is foo's documentation\n */\nclass Foo {\n /**\n * The method\n * @param {number} x Param to method\n */\n method(x) {\n }\n}\n\n/**\n * Represents an IPv6 address\n *\n * This tests our support of optional parameters\n * @class Address6\n * @param {string} address - An IPv6 address string\n * @param {number} [groups=8] - How many octets to parse\n * @param {?number} third - A third argument\n * @param {Array} [foo=[1]] to properly be parsed\n * @example\n * var address = new Address6('2001::/32');\n */\nfunction Address6() {}\n\n/**\n * Create a GeoJSON data source instance given an options object\n *\n * This tests our support of nested parameters\n * @class GeoJSONSource\n * @param {Object} [options] optional options\n * @param {Object|string} options.data A GeoJSON data object or URL to it.\n * The latter is preferable in case of large GeoJSON files.\n * @param {number} [options.maxzoom=14] Maximum zoom to preserve detail at.\n * @param {number} [options.buffer] Tile buffer on each side.\n * @param {number} [options.tolerance] Simplification tolerance (higher means simpler).\n */\nfunction GeoJSONSource(options) {\n this.options = options;\n}\n\n/**\n * This tests our support for parameters with explicit types but with default\n * values specified in code.\n *\n * @param {number} x an argument\n *\n * @returns {number} some\n */\nexport const myfunc = (x = 123) => x;\n\n/**\n * This tests our support of JSDoc param tags without type information,\n * or any type information we could infer from annotations.\n *\n * @param address - An IPv6 address string\n */\nfunction foo(address) {\n return address;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"params": [
|
|
{
|
|
"title": "param",
|
|
"name": "$0",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
},
|
|
"properties": [
|
|
{
|
|
"name": "$0.fishes",
|
|
"lineNumber": 2,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number of kinds of fish",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 24,
|
|
"offset": 23
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 24,
|
|
"offset": 23
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 24,
|
|
"offset": 23
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "String"
|
|
}
|
|
},
|
|
{
|
|
"title": "param",
|
|
"name": "$0.foxes",
|
|
"lineNumber": 13
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "fishesAndFoxes",
|
|
"kind": "function",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"fishesAndFoxes"
|
|
]
|
|
},
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This method has a type in the description and a default in the code",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 68,
|
|
"offset": 67
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 68,
|
|
"offset": 67
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 68,
|
|
"offset": 67
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": null,
|
|
"lineNumber": 2,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "x"
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 17,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 20,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 21,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 23,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "/**\n * This function returns the number one.\n * @param {number} b the second param\n */\nfunction addThem(a, b, c, { d, e, f }) {\n return a + b + c + d + e + f;\n}\n\n/**\n * This method has partially inferred params\n * @param {String} $0.fishes number of kinds of fish\n */\nfunction fishesAndFoxes({ fishes, foxes }) {\n return fishes + foxes;\n}\n\n/**\n * This method has a type in the description and a default in the code\n * @param {number} x\n */\nfunction withDefault(x = 2) {\n return x;\n}\n\n/**\n * This is foo's documentation\n */\nclass Foo {\n /**\n * The method\n * @param {number} x Param to method\n */\n method(x) {\n }\n}\n\n/**\n * Represents an IPv6 address\n *\n * This tests our support of optional parameters\n * @class Address6\n * @param {string} address - An IPv6 address string\n * @param {number} [groups=8] - How many octets to parse\n * @param {?number} third - A third argument\n * @param {Array} [foo=[1]] to properly be parsed\n * @example\n * var address = new Address6('2001::/32');\n */\nfunction Address6() {}\n\n/**\n * Create a GeoJSON data source instance given an options object\n *\n * This tests our support of nested parameters\n * @class GeoJSONSource\n * @param {Object} [options] optional options\n * @param {Object|string} options.data A GeoJSON data object or URL to it.\n * The latter is preferable in case of large GeoJSON files.\n * @param {number} [options.maxzoom=14] Maximum zoom to preserve detail at.\n * @param {number} [options.buffer] Tile buffer on each side.\n * @param {number} [options.tolerance] Simplification tolerance (higher means simpler).\n */\nfunction GeoJSONSource(options) {\n this.options = options;\n}\n\n/**\n * This tests our support for parameters with explicit types but with default\n * values specified in code.\n *\n * @param {number} x an argument\n *\n * @returns {number} some\n */\nexport const myfunc = (x = 123) => x;\n\n/**\n * This tests our support of JSDoc param tags without type information,\n * or any type information we could infer from annotations.\n *\n * @param address - An IPv6 address string\n */\nfunction foo(address) {\n return address;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"params": [
|
|
{
|
|
"name": "x",
|
|
"lineNumber": 2,
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"default": "2"
|
|
}
|
|
}
|
|
],
|
|
"name": "withDefault",
|
|
"kind": "function",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"withDefault"
|
|
]
|
|
},
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This is foo's documentation",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 28,
|
|
"offset": 27
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 28,
|
|
"offset": 27
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 28,
|
|
"offset": 27
|
|
}
|
|
}
|
|
},
|
|
"tags": [],
|
|
"loc": {
|
|
"start": {
|
|
"line": 25,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 27,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 28,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 35,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "/**\n * This function returns the number one.\n * @param {number} b the second param\n */\nfunction addThem(a, b, c, { d, e, f }) {\n return a + b + c + d + e + f;\n}\n\n/**\n * This method has partially inferred params\n * @param {String} $0.fishes number of kinds of fish\n */\nfunction fishesAndFoxes({ fishes, foxes }) {\n return fishes + foxes;\n}\n\n/**\n * This method has a type in the description and a default in the code\n * @param {number} x\n */\nfunction withDefault(x = 2) {\n return x;\n}\n\n/**\n * This is foo's documentation\n */\nclass Foo {\n /**\n * The method\n * @param {number} x Param to method\n */\n method(x) {\n }\n}\n\n/**\n * Represents an IPv6 address\n *\n * This tests our support of optional parameters\n * @class Address6\n * @param {string} address - An IPv6 address string\n * @param {number} [groups=8] - How many octets to parse\n * @param {?number} third - A third argument\n * @param {Array} [foo=[1]] to properly be parsed\n * @example\n * var address = new Address6('2001::/32');\n */\nfunction Address6() {}\n\n/**\n * Create a GeoJSON data source instance given an options object\n *\n * This tests our support of nested parameters\n * @class GeoJSONSource\n * @param {Object} [options] optional options\n * @param {Object|string} options.data A GeoJSON data object or URL to it.\n * The latter is preferable in case of large GeoJSON files.\n * @param {number} [options.maxzoom=14] Maximum zoom to preserve detail at.\n * @param {number} [options.buffer] Tile buffer on each side.\n * @param {number} [options.tolerance] Simplification tolerance (higher means simpler).\n */\nfunction GeoJSONSource(options) {\n this.options = options;\n}\n\n/**\n * This tests our support for parameters with explicit types but with default\n * values specified in code.\n *\n * @param {number} x an argument\n *\n * @returns {number} some\n */\nexport const myfunc = (x = 123) => x;\n\n/**\n * This tests our support of JSDoc param tags without type information,\n * or any type information we could infer from annotations.\n *\n * @param address - An IPv6 address string\n */\nfunction foo(address) {\n return address;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"name": "Foo",
|
|
"kind": "class",
|
|
"members": {
|
|
"instance": [
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "The method",
|
|
"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
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": "Param to method",
|
|
"lineNumber": 2,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "x"
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 29,
|
|
"column": 2
|
|
},
|
|
"end": {
|
|
"line": 32,
|
|
"column": 5
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 33,
|
|
"column": 2
|
|
},
|
|
"end": {
|
|
"line": 34,
|
|
"column": 3
|
|
}
|
|
},
|
|
"code": "/**\n * This function returns the number one.\n * @param {number} b the second param\n */\nfunction addThem(a, b, c, { d, e, f }) {\n return a + b + c + d + e + f;\n}\n\n/**\n * This method has partially inferred params\n * @param {String} $0.fishes number of kinds of fish\n */\nfunction fishesAndFoxes({ fishes, foxes }) {\n return fishes + foxes;\n}\n\n/**\n * This method has a type in the description and a default in the code\n * @param {number} x\n */\nfunction withDefault(x = 2) {\n return x;\n}\n\n/**\n * This is foo's documentation\n */\nclass Foo {\n /**\n * The method\n * @param {number} x Param to method\n */\n method(x) {\n }\n}\n\n/**\n * Represents an IPv6 address\n *\n * This tests our support of optional parameters\n * @class Address6\n * @param {string} address - An IPv6 address string\n * @param {number} [groups=8] - How many octets to parse\n * @param {?number} third - A third argument\n * @param {Array} [foo=[1]] to properly be parsed\n * @example\n * var address = new Address6('2001::/32');\n */\nfunction Address6() {}\n\n/**\n * Create a GeoJSON data source instance given an options object\n *\n * This tests our support of nested parameters\n * @class GeoJSONSource\n * @param {Object} [options] optional options\n * @param {Object|string} options.data A GeoJSON data object or URL to it.\n * The latter is preferable in case of large GeoJSON files.\n * @param {number} [options.maxzoom=14] Maximum zoom to preserve detail at.\n * @param {number} [options.buffer] Tile buffer on each side.\n * @param {number} [options.tolerance] Simplification tolerance (higher means simpler).\n */\nfunction GeoJSONSource(options) {\n this.options = options;\n}\n\n/**\n * This tests our support for parameters with explicit types but with default\n * values specified in code.\n *\n * @param {number} x an argument\n *\n * @returns {number} some\n */\nexport const myfunc = (x = 123) => x;\n\n/**\n * This tests our support of JSDoc param tags without type information,\n * or any type information we could infer from annotations.\n *\n * @param address - An IPv6 address string\n */\nfunction foo(address) {\n return address;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"params": [
|
|
{
|
|
"name": "x",
|
|
"lineNumber": 2,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Param to method",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 16,
|
|
"offset": 15
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 16,
|
|
"offset": 15
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 16,
|
|
"offset": 15
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"name": "method",
|
|
"kind": "function",
|
|
"memberof": "Foo",
|
|
"scope": "instance",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"Foo",
|
|
"method"
|
|
]
|
|
}
|
|
],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"Foo"
|
|
]
|
|
},
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Represents an IPv6 address",
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This tests our support of optional parameters",
|
|
"position": {
|
|
"start": {
|
|
"line": 3,
|
|
"column": 1,
|
|
"offset": 28
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 47,
|
|
"offset": 74
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 3,
|
|
"column": 1,
|
|
"offset": 28
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 47,
|
|
"offset": 74
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 47,
|
|
"offset": 74
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "class",
|
|
"description": null,
|
|
"lineNumber": 4,
|
|
"type": null,
|
|
"name": "Address6"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "An IPv6 address string",
|
|
"lineNumber": 5,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "string"
|
|
},
|
|
"name": "address"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "How many octets to parse",
|
|
"lineNumber": 6,
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
},
|
|
"name": "groups",
|
|
"default": "8"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "A third argument",
|
|
"lineNumber": 7,
|
|
"type": {
|
|
"type": "NullableType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"prefix": true
|
|
},
|
|
"name": "third"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "to properly be parsed",
|
|
"lineNumber": 8,
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "Array"
|
|
}
|
|
},
|
|
"name": "foo",
|
|
"default": "[1]"
|
|
},
|
|
{
|
|
"title": "example",
|
|
"description": "var address = new Address6('2001::/32');",
|
|
"lineNumber": 9
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 37,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 48,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 49,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 49,
|
|
"column": 22
|
|
}
|
|
},
|
|
"code": "/**\n * This function returns the number one.\n * @param {number} b the second param\n */\nfunction addThem(a, b, c, { d, e, f }) {\n return a + b + c + d + e + f;\n}\n\n/**\n * This method has partially inferred params\n * @param {String} $0.fishes number of kinds of fish\n */\nfunction fishesAndFoxes({ fishes, foxes }) {\n return fishes + foxes;\n}\n\n/**\n * This method has a type in the description and a default in the code\n * @param {number} x\n */\nfunction withDefault(x = 2) {\n return x;\n}\n\n/**\n * This is foo's documentation\n */\nclass Foo {\n /**\n * The method\n * @param {number} x Param to method\n */\n method(x) {\n }\n}\n\n/**\n * Represents an IPv6 address\n *\n * This tests our support of optional parameters\n * @class Address6\n * @param {string} address - An IPv6 address string\n * @param {number} [groups=8] - How many octets to parse\n * @param {?number} third - A third argument\n * @param {Array} [foo=[1]] to properly be parsed\n * @example\n * var address = new Address6('2001::/32');\n */\nfunction Address6() {}\n\n/**\n * Create a GeoJSON data source instance given an options object\n *\n * This tests our support of nested parameters\n * @class GeoJSONSource\n * @param {Object} [options] optional options\n * @param {Object|string} options.data A GeoJSON data object or URL to it.\n * The latter is preferable in case of large GeoJSON files.\n * @param {number} [options.maxzoom=14] Maximum zoom to preserve detail at.\n * @param {number} [options.buffer] Tile buffer on each side.\n * @param {number} [options.tolerance] Simplification tolerance (higher means simpler).\n */\nfunction GeoJSONSource(options) {\n this.options = options;\n}\n\n/**\n * This tests our support for parameters with explicit types but with default\n * values specified in code.\n *\n * @param {number} x an argument\n *\n * @returns {number} some\n */\nexport const myfunc = (x = 123) => x;\n\n/**\n * This tests our support of JSDoc param tags without type information,\n * or any type information we could infer from annotations.\n *\n * @param address - An IPv6 address string\n */\nfunction foo(address) {\n return address;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"kind": "class",
|
|
"name": "Address6",
|
|
"params": [
|
|
{
|
|
"name": "address",
|
|
"lineNumber": 5,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "An IPv6 address string",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 23,
|
|
"offset": 22
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 23,
|
|
"offset": 22
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 23,
|
|
"offset": 22
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "groups",
|
|
"lineNumber": 6,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "How many octets to parse",
|
|
"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": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "third",
|
|
"lineNumber": 7,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "A third argument",
|
|
"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": "NullableType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"prefix": true
|
|
}
|
|
},
|
|
{
|
|
"name": "foo",
|
|
"lineNumber": 8,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "to properly be parsed",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 22,
|
|
"offset": 21
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 22,
|
|
"offset": 21
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 22,
|
|
"offset": 21
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "Array"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"examples": [
|
|
{
|
|
"description": "var address = new Address6('2001::/32');"
|
|
}
|
|
],
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"Address6"
|
|
]
|
|
},
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This function returns the number one.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 38,
|
|
"offset": 37
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 38,
|
|
"offset": 37
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 38,
|
|
"offset": 37
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": "the second param",
|
|
"lineNumber": 2,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "b"
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 4,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 5,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 7,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "/**\n * This function returns the number one.\n * @param {number} b the second param\n */\nfunction addThem(a, b, c, { d, e, f }) {\n return a + b + c + d + e + f;\n}\n\n/**\n * This method has partially inferred params\n * @param {String} $0.fishes number of kinds of fish\n */\nfunction fishesAndFoxes({ fishes, foxes }) {\n return fishes + foxes;\n}\n\n/**\n * This method has a type in the description and a default in the code\n * @param {number} x\n */\nfunction withDefault(x = 2) {\n return x;\n}\n\n/**\n * This is foo's documentation\n */\nclass Foo {\n /**\n * The method\n * @param {number} x Param to method\n */\n method(x) {\n }\n}\n\n/**\n * Represents an IPv6 address\n *\n * This tests our support of optional parameters\n * @class Address6\n * @param {string} address - An IPv6 address string\n * @param {number} [groups=8] - How many octets to parse\n * @param {?number} third - A third argument\n * @param {Array} [foo=[1]] to properly be parsed\n * @example\n * var address = new Address6('2001::/32');\n */\nfunction Address6() {}\n\n/**\n * Create a GeoJSON data source instance given an options object\n *\n * This tests our support of nested parameters\n * @class GeoJSONSource\n * @param {Object} [options] optional options\n * @param {Object|string} options.data A GeoJSON data object or URL to it.\n * The latter is preferable in case of large GeoJSON files.\n * @param {number} [options.maxzoom=14] Maximum zoom to preserve detail at.\n * @param {number} [options.buffer] Tile buffer on each side.\n * @param {number} [options.tolerance] Simplification tolerance (higher means simpler).\n */\nfunction GeoJSONSource(options) {\n this.options = options;\n}\n\n/**\n * This tests our support for parameters with explicit types but with default\n * values specified in code.\n *\n * @param {number} x an argument\n *\n * @returns {number} some\n */\nexport const myfunc = (x = 123) => x;\n\n/**\n * This tests our support of JSDoc param tags without type information,\n * or any type information we could infer from annotations.\n *\n * @param address - An IPv6 address string\n */\nfunction foo(address) {\n return address;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"params": [
|
|
{
|
|
"title": "param",
|
|
"name": "a",
|
|
"lineNumber": 5
|
|
},
|
|
{
|
|
"name": "b",
|
|
"lineNumber": 2,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "the second param",
|
|
"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": "number"
|
|
}
|
|
},
|
|
{
|
|
"title": "param",
|
|
"name": "c",
|
|
"lineNumber": 5
|
|
},
|
|
{
|
|
"title": "param",
|
|
"name": "$3",
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
},
|
|
"properties": [
|
|
{
|
|
"title": "param",
|
|
"name": "$3.d",
|
|
"lineNumber": 5
|
|
},
|
|
{
|
|
"title": "param",
|
|
"name": "$3.e",
|
|
"lineNumber": 5
|
|
},
|
|
{
|
|
"title": "param",
|
|
"name": "$3.f",
|
|
"lineNumber": 5
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"name": "addThem",
|
|
"kind": "function",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"addThem"
|
|
]
|
|
},
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Create a GeoJSON data source instance given an options object",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 62,
|
|
"offset": 61
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 62,
|
|
"offset": 61
|
|
},
|
|
"indent": []
|
|
}
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This tests our support of nested parameters",
|
|
"position": {
|
|
"start": {
|
|
"line": 3,
|
|
"column": 1,
|
|
"offset": 63
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 44,
|
|
"offset": 106
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 3,
|
|
"column": 1,
|
|
"offset": 63
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 44,
|
|
"offset": 106
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 44,
|
|
"offset": 106
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "class",
|
|
"description": null,
|
|
"lineNumber": 4,
|
|
"type": null,
|
|
"name": "GeoJSONSource"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "optional options",
|
|
"lineNumber": 5,
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
}
|
|
},
|
|
"name": "options"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "A GeoJSON data object or URL to it.\nThe latter is preferable in case of large GeoJSON files.",
|
|
"lineNumber": 6,
|
|
"type": {
|
|
"type": "UnionType",
|
|
"elements": [
|
|
{
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
},
|
|
{
|
|
"type": "NameExpression",
|
|
"name": "string"
|
|
}
|
|
]
|
|
},
|
|
"name": "options.data"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "Maximum zoom to preserve detail at.",
|
|
"lineNumber": 8,
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
},
|
|
"name": "options.maxzoom",
|
|
"default": "14"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "Tile buffer on each side.",
|
|
"lineNumber": 9,
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
},
|
|
"name": "options.buffer"
|
|
},
|
|
{
|
|
"title": "param",
|
|
"description": "Simplification tolerance (higher means simpler).",
|
|
"lineNumber": 10,
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
},
|
|
"name": "options.tolerance"
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 51,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 62,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 63,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 65,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "/**\n * This function returns the number one.\n * @param {number} b the second param\n */\nfunction addThem(a, b, c, { d, e, f }) {\n return a + b + c + d + e + f;\n}\n\n/**\n * This method has partially inferred params\n * @param {String} $0.fishes number of kinds of fish\n */\nfunction fishesAndFoxes({ fishes, foxes }) {\n return fishes + foxes;\n}\n\n/**\n * This method has a type in the description and a default in the code\n * @param {number} x\n */\nfunction withDefault(x = 2) {\n return x;\n}\n\n/**\n * This is foo's documentation\n */\nclass Foo {\n /**\n * The method\n * @param {number} x Param to method\n */\n method(x) {\n }\n}\n\n/**\n * Represents an IPv6 address\n *\n * This tests our support of optional parameters\n * @class Address6\n * @param {string} address - An IPv6 address string\n * @param {number} [groups=8] - How many octets to parse\n * @param {?number} third - A third argument\n * @param {Array} [foo=[1]] to properly be parsed\n * @example\n * var address = new Address6('2001::/32');\n */\nfunction Address6() {}\n\n/**\n * Create a GeoJSON data source instance given an options object\n *\n * This tests our support of nested parameters\n * @class GeoJSONSource\n * @param {Object} [options] optional options\n * @param {Object|string} options.data A GeoJSON data object or URL to it.\n * The latter is preferable in case of large GeoJSON files.\n * @param {number} [options.maxzoom=14] Maximum zoom to preserve detail at.\n * @param {number} [options.buffer] Tile buffer on each side.\n * @param {number} [options.tolerance] Simplification tolerance (higher means simpler).\n */\nfunction GeoJSONSource(options) {\n this.options = options;\n}\n\n/**\n * This tests our support for parameters with explicit types but with default\n * values specified in code.\n *\n * @param {number} x an argument\n *\n * @returns {number} some\n */\nexport const myfunc = (x = 123) => x;\n\n/**\n * This tests our support of JSDoc param tags without type information,\n * or any type information we could infer from annotations.\n *\n * @param address - An IPv6 address string\n */\nfunction foo(address) {\n return address;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"kind": "class",
|
|
"name": "GeoJSONSource",
|
|
"params": [
|
|
{
|
|
"name": "options",
|
|
"lineNumber": 5,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "optional options",
|
|
"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": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
}
|
|
},
|
|
"properties": [
|
|
{
|
|
"name": "options.data",
|
|
"lineNumber": 6,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "A GeoJSON data object or URL to it.\nThe latter is preferable in case of large GeoJSON files.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 57,
|
|
"offset": 92
|
|
},
|
|
"indent": [
|
|
1
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 57,
|
|
"offset": 92
|
|
},
|
|
"indent": [
|
|
1
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 57,
|
|
"offset": 92
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "UnionType",
|
|
"elements": [
|
|
{
|
|
"type": "NameExpression",
|
|
"name": "Object"
|
|
},
|
|
{
|
|
"type": "NameExpression",
|
|
"name": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"name": "options.maxzoom",
|
|
"lineNumber": 8,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Maximum zoom to preserve detail at.",
|
|
"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
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "options.buffer",
|
|
"lineNumber": 9,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Tile buffer on each side.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 26,
|
|
"offset": 25
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 26,
|
|
"offset": 25
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 26,
|
|
"offset": 25
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "options.tolerance",
|
|
"lineNumber": 10,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Simplification tolerance (higher means simpler).",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 49,
|
|
"offset": 48
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 49,
|
|
"offset": 48
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 49,
|
|
"offset": 48
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "OptionalType",
|
|
"expression": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"GeoJSONSource"
|
|
]
|
|
},
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This tests our support for parameters with explicit types but with default\nvalues specified in code.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 26,
|
|
"offset": 100
|
|
},
|
|
"indent": [
|
|
1
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 26,
|
|
"offset": 100
|
|
},
|
|
"indent": [
|
|
1
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 26,
|
|
"offset": 100
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": "an argument",
|
|
"lineNumber": 4,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
},
|
|
"name": "x"
|
|
},
|
|
{
|
|
"title": "returns",
|
|
"description": "some",
|
|
"lineNumber": 6,
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 67,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 74,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 75,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 75,
|
|
"column": 37
|
|
}
|
|
},
|
|
"code": "/**\n * This function returns the number one.\n * @param {number} b the second param\n */\nfunction addThem(a, b, c, { d, e, f }) {\n return a + b + c + d + e + f;\n}\n\n/**\n * This method has partially inferred params\n * @param {String} $0.fishes number of kinds of fish\n */\nfunction fishesAndFoxes({ fishes, foxes }) {\n return fishes + foxes;\n}\n\n/**\n * This method has a type in the description and a default in the code\n * @param {number} x\n */\nfunction withDefault(x = 2) {\n return x;\n}\n\n/**\n * This is foo's documentation\n */\nclass Foo {\n /**\n * The method\n * @param {number} x Param to method\n */\n method(x) {\n }\n}\n\n/**\n * Represents an IPv6 address\n *\n * This tests our support of optional parameters\n * @class Address6\n * @param {string} address - An IPv6 address string\n * @param {number} [groups=8] - How many octets to parse\n * @param {?number} third - A third argument\n * @param {Array} [foo=[1]] to properly be parsed\n * @example\n * var address = new Address6('2001::/32');\n */\nfunction Address6() {}\n\n/**\n * Create a GeoJSON data source instance given an options object\n *\n * This tests our support of nested parameters\n * @class GeoJSONSource\n * @param {Object} [options] optional options\n * @param {Object|string} options.data A GeoJSON data object or URL to it.\n * The latter is preferable in case of large GeoJSON files.\n * @param {number} [options.maxzoom=14] Maximum zoom to preserve detail at.\n * @param {number} [options.buffer] Tile buffer on each side.\n * @param {number} [options.tolerance] Simplification tolerance (higher means simpler).\n */\nfunction GeoJSONSource(options) {\n this.options = options;\n}\n\n/**\n * This tests our support for parameters with explicit types but with default\n * values specified in code.\n *\n * @param {number} x an argument\n *\n * @returns {number} some\n */\nexport const myfunc = (x = 123) => x;\n\n/**\n * This tests our support of JSDoc param tags without type information,\n * or any type information we could infer from annotations.\n *\n * @param address - An IPv6 address string\n */\nfunction foo(address) {\n return address;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"params": [
|
|
{
|
|
"name": "x",
|
|
"lineNumber": 4,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "an argument",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 12,
|
|
"offset": 11
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 12,
|
|
"offset": 11
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 12,
|
|
"offset": 11
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"returns": [
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "some",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 5,
|
|
"offset": 4
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 5,
|
|
"offset": 4
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 5,
|
|
"offset": 4
|
|
}
|
|
}
|
|
},
|
|
"type": {
|
|
"type": "NameExpression",
|
|
"name": "number"
|
|
}
|
|
}
|
|
],
|
|
"name": "myfunc",
|
|
"kind": "constant",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"myfunc"
|
|
]
|
|
},
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "This tests our support of JSDoc param tags without type information,\nor any type information we could infer from annotations.",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 57,
|
|
"offset": 125
|
|
},
|
|
"indent": [
|
|
1
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 57,
|
|
"offset": 125
|
|
},
|
|
"indent": [
|
|
1
|
|
]
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 2,
|
|
"column": 57,
|
|
"offset": 125
|
|
}
|
|
}
|
|
},
|
|
"tags": [
|
|
{
|
|
"title": "param",
|
|
"description": "An IPv6 address string",
|
|
"lineNumber": 4,
|
|
"type": null,
|
|
"name": "address"
|
|
}
|
|
],
|
|
"loc": {
|
|
"start": {
|
|
"line": 77,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 82,
|
|
"column": 3
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 83,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 85,
|
|
"column": 1
|
|
}
|
|
},
|
|
"code": "/**\n * This function returns the number one.\n * @param {number} b the second param\n */\nfunction addThem(a, b, c, { d, e, f }) {\n return a + b + c + d + e + f;\n}\n\n/**\n * This method has partially inferred params\n * @param {String} $0.fishes number of kinds of fish\n */\nfunction fishesAndFoxes({ fishes, foxes }) {\n return fishes + foxes;\n}\n\n/**\n * This method has a type in the description and a default in the code\n * @param {number} x\n */\nfunction withDefault(x = 2) {\n return x;\n}\n\n/**\n * This is foo's documentation\n */\nclass Foo {\n /**\n * The method\n * @param {number} x Param to method\n */\n method(x) {\n }\n}\n\n/**\n * Represents an IPv6 address\n *\n * This tests our support of optional parameters\n * @class Address6\n * @param {string} address - An IPv6 address string\n * @param {number} [groups=8] - How many octets to parse\n * @param {?number} third - A third argument\n * @param {Array} [foo=[1]] to properly be parsed\n * @example\n * var address = new Address6('2001::/32');\n */\nfunction Address6() {}\n\n/**\n * Create a GeoJSON data source instance given an options object\n *\n * This tests our support of nested parameters\n * @class GeoJSONSource\n * @param {Object} [options] optional options\n * @param {Object|string} options.data A GeoJSON data object or URL to it.\n * The latter is preferable in case of large GeoJSON files.\n * @param {number} [options.maxzoom=14] Maximum zoom to preserve detail at.\n * @param {number} [options.buffer] Tile buffer on each side.\n * @param {number} [options.tolerance] Simplification tolerance (higher means simpler).\n */\nfunction GeoJSONSource(options) {\n this.options = options;\n}\n\n/**\n * This tests our support for parameters with explicit types but with default\n * values specified in code.\n *\n * @param {number} x an argument\n *\n * @returns {number} some\n */\nexport const myfunc = (x = 123) => x;\n\n/**\n * This tests our support of JSDoc param tags without type information,\n * or any type information we could infer from annotations.\n *\n * @param address - An IPv6 address string\n */\nfunction foo(address) {\n return address;\n}\n"
|
|
},
|
|
"errors": [],
|
|
"params": [
|
|
{
|
|
"name": "address",
|
|
"lineNumber": 4,
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "An IPv6 address string",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 23,
|
|
"offset": 22
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 23,
|
|
"offset": 22
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 23,
|
|
"offset": 22
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"name": "foo",
|
|
"kind": "function",
|
|
"members": {
|
|
"instance": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
"foo"
|
|
]
|
|
}
|
|
] |