forked from web3/web3.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tsdoc.json
87 lines (86 loc) · 1.55 KB
/
tsdoc.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"tagDefinitions": [
{
"tagName": "@alias",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@function",
"syntaxKind": "inline",
"allowMultiple": false
},
{
"tagName": "@doclink",
"syntaxKind": "inline",
"allowMultiple": true
},
// TODO: When following fix is released we can replace below configuration with `extend`
// https://github.com/TypeStrong/typedoc/issues/2015
// "extends": ["typedoc/tsdoc.json"],
{
"tagName": "@module",
"syntaxKind": "block"
},
{
"tagName": "@typedef",
"syntaxKind": "block"
},
{
"tagName": "@callback",
"syntaxKind": "block"
},
{
"tagName": "@prop",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@property",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@group",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@category",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@hidden",
"syntaxKind": "modifier"
},
{
"tagName": "@ignore",
"syntaxKind": "modifier"
},
{
"tagName": "@enum",
"syntaxKind": "modifier"
},
{
"tagName": "@event",
"syntaxKind": "modifier"
},
{
"tagName": "@template",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@linkcode",
"syntaxKind": "inline",
"allowMultiple": true
},
{
"tagName": "@linkplain",
"syntaxKind": "block",
"allowMultiple": true
}
]
}