Skip to content

Commit 10f7131

Browse files
author
Anand Thakker
committed
Add very rudimentary support for @typedef
1 parent fed3871 commit 10f7131

File tree

4 files changed

+120
-0
lines changed

4 files changed

+120
-0
lines changed

test/fixture/typedef.input.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/**
2+
* A type definition.
3+
* @name MyType
4+
* @typedef {Object} MyType
5+
* @property {number} prop1 - one property
6+
* @property {string} prop2 - another property
7+
*/
8+

test/fixture/typedef.output.custom.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## `MyType`
2+
3+
A type definition.
4+
5+
6+

test/fixture/typedef.output.json

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
[
2+
{
3+
"description": "A type definition.",
4+
"tags": [
5+
{
6+
"title": "name",
7+
"description": null,
8+
"lineNumber": 2,
9+
"name": "MyType"
10+
},
11+
{
12+
"title": "typedef",
13+
"description": "MyType",
14+
"lineNumber": 3,
15+
"type": {
16+
"type": "NameExpression",
17+
"name": "Object"
18+
}
19+
},
20+
{
21+
"title": "property",
22+
"description": "one property",
23+
"lineNumber": 4,
24+
"type": {
25+
"type": "NameExpression",
26+
"name": "number"
27+
},
28+
"name": "prop1"
29+
},
30+
{
31+
"title": "property",
32+
"description": "another property",
33+
"lineNumber": 5,
34+
"type": {
35+
"type": "NameExpression",
36+
"name": "string"
37+
},
38+
"name": "prop2"
39+
},
40+
{
41+
"title": "kind",
42+
"kind": "typedef"
43+
}
44+
],
45+
"loc": {
46+
"start": {
47+
"line": 1,
48+
"column": 0
49+
},
50+
"end": {
51+
"line": 7,
52+
"column": 3
53+
}
54+
},
55+
"context": {
56+
"loc": {
57+
"start": {
58+
"line": 9,
59+
"column": 0
60+
},
61+
"end": {
62+
"line": 9,
63+
"column": 0
64+
}
65+
},
66+
"file": "fixture/typedef.input.js"
67+
},
68+
"name": "MyType",
69+
"properties": [
70+
{
71+
"title": "property",
72+
"description": "one property",
73+
"lineNumber": 4,
74+
"type": {
75+
"type": "NameExpression",
76+
"name": "number"
77+
},
78+
"name": "prop1"
79+
},
80+
{
81+
"title": "property",
82+
"description": "another property",
83+
"lineNumber": 5,
84+
"type": {
85+
"type": "NameExpression",
86+
"name": "string"
87+
},
88+
"name": "prop2"
89+
}
90+
],
91+
"kind": "typedef"
92+
}
93+
]

test/fixture/typedef.output.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## `MyType`
2+
3+
A type definition.
4+
5+
6+
| name | type | description |
7+
| ---- | ---- | ----------- |
8+
| `prop1` | `number` | one property |
9+
| `prop2` | `string` | another property |
10+
11+
12+
13+

0 commit comments

Comments
 (0)