Last active
June 26, 2017 20:08
-
-
Save tmcw/87f3ad764851a03e679cf814c1d8a95a to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /** | |
| * This is a {@link Foo} | |
| * @param {Object} options | |
| * @param {Object[]} options.employees - The employee who is responsible for the project. | |
| * @param {string} options.employees[].name - The name of the employee. | |
| * @param {string} options.employees[].department - The employee's department. | |
| */ | |
| function a(options) {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| [ | |
| { | |
| "description": { | |
| "type": "root", | |
| "children": [ | |
| { | |
| "type": "paragraph", | |
| "children": [ | |
| { | |
| "type": "text", | |
| "value": "This is a ", | |
| "position": { | |
| "start": { | |
| "line": 1, | |
| "column": 1, | |
| "offset": 0 | |
| }, | |
| "end": { | |
| "line": 1, | |
| "column": 11, | |
| "offset": 10 | |
| }, | |
| "indent": [] | |
| } | |
| }, | |
| { | |
| "type": "link", | |
| "url": "Foo", | |
| "title": null, | |
| "jsdoc": true, | |
| "children": [ | |
| { | |
| "type": "text", | |
| "value": "Foo" | |
| } | |
| ], | |
| "position": { | |
| "start": { | |
| "line": 1, | |
| "column": 11, | |
| "offset": 10 | |
| }, | |
| "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 | |
| } | |
| } | |
| }, | |
| "tags": [ | |
| { | |
| "title": "param", | |
| "description": null, | |
| "lineNumber": 2, | |
| "type": { | |
| "type": "NameExpression", | |
| "name": "Object" | |
| }, | |
| "name": "options" | |
| }, | |
| { | |
| "title": "param", | |
| "description": "The employee who is responsible for the project.", | |
| "lineNumber": 3, | |
| "type": { | |
| "type": "TypeApplication", | |
| "expression": { | |
| "type": "NameExpression", | |
| "name": "Array" | |
| }, | |
| "applications": [ | |
| { | |
| "type": "NameExpression", | |
| "name": "Object" | |
| } | |
| ] | |
| }, | |
| "name": "options.employees" | |
| }, | |
| { | |
| "title": "param", | |
| "description": "[].name - The name of the employee.", | |
| "lineNumber": 4, | |
| "type": { | |
| "type": "NameExpression", | |
| "name": "string" | |
| }, | |
| "name": "options.employees" | |
| }, | |
| { | |
| "title": "param", | |
| "description": "[].department - The employee's department.", | |
| "lineNumber": 5, | |
| "type": { | |
| "type": "NameExpression", | |
| "name": "string" | |
| }, | |
| "name": "options.employees" | |
| } | |
| ], | |
| "loc": { | |
| "start": { | |
| "line": 1, | |
| "column": 0 | |
| }, | |
| "end": { | |
| "line": 7, | |
| "column": 3 | |
| } | |
| }, | |
| "context": { | |
| "loc": { | |
| "start": { | |
| "line": 8, | |
| "column": 0 | |
| }, | |
| "end": { | |
| "line": 8, | |
| "column": 22 | |
| } | |
| }, | |
| "file": "/Users/tmcw/src/documentation/foo.js" | |
| }, | |
| "augments": [], | |
| "examples": [], | |
| "params": [ | |
| { | |
| "title": "param", | |
| "name": "options", | |
| "lineNumber": 2, | |
| "type": { | |
| "type": "NameExpression", | |
| "name": "Object" | |
| }, | |
| "properties": [ | |
| { | |
| "title": "param", | |
| "name": "options.employees", | |
| "lineNumber": 3, | |
| "description": { | |
| "type": "root", | |
| "children": [ | |
| { | |
| "type": "paragraph", | |
| "children": [ | |
| { | |
| "type": "text", | |
| "value": "The employee who is responsible for the project.", | |
| "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": "TypeApplication", | |
| "expression": { | |
| "type": "NameExpression", | |
| "name": "Array" | |
| }, | |
| "applications": [ | |
| { | |
| "type": "NameExpression", | |
| "name": "Object" | |
| } | |
| ] | |
| } | |
| }, | |
| { | |
| "title": "param", | |
| "name": "options.employees", | |
| "lineNumber": 4, | |
| "description": { | |
| "type": "root", | |
| "children": [ | |
| { | |
| "type": "paragraph", | |
| "children": [ | |
| { | |
| "type": "text", | |
| "value": "[].name - The name of the employee.", | |
| "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": "NameExpression", | |
| "name": "string" | |
| } | |
| }, | |
| { | |
| "title": "param", | |
| "name": "options.employees", | |
| "lineNumber": 5, | |
| "description": { | |
| "type": "root", | |
| "children": [ | |
| { | |
| "type": "paragraph", | |
| "children": [ | |
| { | |
| "type": "text", | |
| "value": "[].department - The employee's department.", | |
| "position": { | |
| "start": { | |
| "line": 1, | |
| "column": 1, | |
| "offset": 0 | |
| }, | |
| "end": { | |
| "line": 1, | |
| "column": 43, | |
| "offset": 42 | |
| }, | |
| "indent": [] | |
| } | |
| } | |
| ], | |
| "position": { | |
| "start": { | |
| "line": 1, | |
| "column": 1, | |
| "offset": 0 | |
| }, | |
| "end": { | |
| "line": 1, | |
| "column": 43, | |
| "offset": 42 | |
| }, | |
| "indent": [] | |
| } | |
| } | |
| ], | |
| "position": { | |
| "start": { | |
| "line": 1, | |
| "column": 1, | |
| "offset": 0 | |
| }, | |
| "end": { | |
| "line": 1, | |
| "column": 43, | |
| "offset": 42 | |
| } | |
| } | |
| }, | |
| "type": { | |
| "type": "NameExpression", | |
| "name": "string" | |
| } | |
| } | |
| ] | |
| } | |
| ], | |
| "properties": [], | |
| "returns": [], | |
| "sees": [], | |
| "throws": [], | |
| "todos": [], | |
| "name": "a", | |
| "kind": "function", | |
| "members": { | |
| "global": [], | |
| "inner": [], | |
| "instance": [], | |
| "events": [], | |
| "static": [] | |
| }, | |
| "path": [ | |
| { | |
| "name": "a", | |
| "kind": "function" | |
| } | |
| ], | |
| "namespace": "a" | |
| } | |
| ] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment