mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
- Tags with `@lends` are now filtered out early on, so they never
generate documentation. Lends tags are structural hints only.
- Uses built-in type checks instead of babel-types where appropriate.
- More internal documentation
- Now reuses code for parsing lends between different forms
Previously broken syntax, now working:
```js
/** parent */
export default function() {
/** child */
this.a = 1;
}
```
214 lines
4.1 KiB
JSON
214 lines
4.1 KiB
JSON
[
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "i am foo",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 9,
|
|
"offset": 8
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 9,
|
|
"offset": 8
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 9,
|
|
"offset": 8
|
|
}
|
|
}
|
|
},
|
|
"tags": [],
|
|
"loc": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 15
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 2,
|
|
"column": 0
|
|
},
|
|
"end": {
|
|
"line": 5,
|
|
"column": 1
|
|
}
|
|
}
|
|
},
|
|
"augments": [],
|
|
"errors": [],
|
|
"examples": [],
|
|
"params": [],
|
|
"properties": [],
|
|
"returns": [],
|
|
"sees": [],
|
|
"throws": [],
|
|
"todos": [],
|
|
"name": "default-export-function.input",
|
|
"kind": "function",
|
|
"members": {
|
|
"global": [],
|
|
"inner": [],
|
|
"instance": [],
|
|
"events": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
{
|
|
"name": "default-export-function.input",
|
|
"kind": "function"
|
|
}
|
|
],
|
|
"namespace": "default-export-function.input"
|
|
},
|
|
{
|
|
"description": {
|
|
"type": "root",
|
|
"children": [
|
|
{
|
|
"type": "paragraph",
|
|
"children": [
|
|
{
|
|
"type": "text",
|
|
"value": "i am foo's son",
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 15,
|
|
"offset": 14
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 15,
|
|
"offset": 14
|
|
},
|
|
"indent": []
|
|
}
|
|
}
|
|
],
|
|
"position": {
|
|
"start": {
|
|
"line": 1,
|
|
"column": 1,
|
|
"offset": 0
|
|
},
|
|
"end": {
|
|
"line": 1,
|
|
"column": 15,
|
|
"offset": 14
|
|
}
|
|
}
|
|
},
|
|
"tags": [],
|
|
"loc": {
|
|
"start": {
|
|
"line": 3,
|
|
"column": 2
|
|
},
|
|
"end": {
|
|
"line": 3,
|
|
"column": 23
|
|
}
|
|
},
|
|
"context": {
|
|
"loc": {
|
|
"start": {
|
|
"line": 4,
|
|
"column": 2
|
|
},
|
|
"end": {
|
|
"line": 4,
|
|
"column": 22
|
|
}
|
|
}
|
|
},
|
|
"augments": [],
|
|
"errors": [
|
|
{
|
|
"message": "@memberof reference to default-export-function.input not found",
|
|
"commentLineNumber": 0
|
|
}
|
|
],
|
|
"examples": [],
|
|
"params": [],
|
|
"properties": [],
|
|
"returns": [],
|
|
"sees": [],
|
|
"throws": [],
|
|
"todos": [],
|
|
"name": "bar",
|
|
"kind": "function",
|
|
"memberof": "default-export-function.input",
|
|
"scope": "static",
|
|
"members": {
|
|
"global": [],
|
|
"inner": [],
|
|
"instance": [],
|
|
"events": [],
|
|
"static": []
|
|
},
|
|
"path": [
|
|
{
|
|
"name": "bar",
|
|
"kind": "function",
|
|
"scope": "static"
|
|
}
|
|
],
|
|
"namespace": ".bar"
|
|
}
|
|
] |