mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
2114 lines
59 KiB
JSON
2114 lines
59 KiB
JSON
{
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "html",
|
|
"value": "<!-- Generated by documentation.js. Update this documentation by updating the source code. -->"
|
|
},
|
|
{
|
|
"depth": 1,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "addThem"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "b"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "a"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "c"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "$3"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Object"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "$3.d"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "$3.e"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "$3.f"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"depth": 1,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "fishesAndFoxes"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "$0"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Object"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "$0.fishes"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "String"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "$0.foxes"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"depth": 1,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "withDefault"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "x"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "["
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "]"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "(default 2)"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"depth": 1,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Foo"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"depth": 2,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "method"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "x"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"depth": 1,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Address6"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "address"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "string"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "groups"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "["
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": " (optional, default "
|
|
},
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "8"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": ")"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "third"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "?"
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "foo"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "["
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Array"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": " (optional, default "
|
|
},
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "[1]"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": ")"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Examples"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"lang": "javascript",
|
|
"type": "code",
|
|
"value": "var address = new Address6('2001::/32');"
|
|
},
|
|
{
|
|
"depth": 1,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "GeoJSONSource"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "options"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "["
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Object"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "options.data"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "("
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Object"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " | "
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "string"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": ")"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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
|
|
]
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "options.maxzoom"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "["
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": " (optional, default "
|
|
},
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "14"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": ")"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "options.buffer"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "["
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "options.tolerance"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "["
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "]"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"depth": 1,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "myfunc"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "x"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "["
|
|
},
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "]"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": "(default 123)"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Returns "
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"href": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number",
|
|
"type": "link",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "number"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"depth": 1,
|
|
"type": "heading",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "foo"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"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
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"type": "strong",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "Parameters"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"ordered": false,
|
|
"type": "list",
|
|
"children": [
|
|
{
|
|
"type": "listItem",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "inlineCode",
|
|
"value": "address"
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"type": "text",
|
|
"value": " "
|
|
},
|
|
{
|
|
"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": []
|
|
}
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
]
|
|
} |