@@ -3,23 +3,34 @@ extracting docs for src/DocExtractionRes.res
3
3
4
4
{
5
5
"name": "DocExtractionRes",
6
+ "deprecated": false,
6
7
"docstrings": ["Module level documentation goes here."],
7
8
"items": [
8
9
{
9
10
"id": "DocExtractionRes.t",
10
11
"kind": "type",
11
12
"name": "t",
13
+ "deprecated": false,
14
+ "location": {
15
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
16
+ "line": 4,
17
+ "col": 1
18
+ },
12
19
"signature": "type t = {name: string, online: bool}",
13
20
"docstrings": ["This type represents stuff."],
14
21
"detail":
15
22
{
16
23
"kind": "record",
17
24
"fieldDocs": [{
18
25
"fieldName": "name",
26
+ "deprecated": false,
27
+ "optional": false,
19
28
"docstrings": ["The name of the stuff."],
20
29
"signature": "string"
21
30
}, {
22
31
"fieldName": "online",
32
+ "deprecated": false,
33
+ "optional": false,
23
34
"docstrings": ["Whether stuff is online."],
24
35
"signature": "bool"
25
36
}]
@@ -29,13 +40,25 @@ extracting docs for src/DocExtractionRes.res
29
40
"id": "DocExtractionRes.make",
30
41
"kind": "value",
31
42
"name": "make",
43
+ "deprecated": false,
44
+ "location": {
45
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
46
+ "line": 17,
47
+ "col": 5
48
+ },
32
49
"signature": "let make: string => t",
33
50
"docstrings": ["Create stuff.\n\n```rescript example\nlet stuff = make(\"My name\")\n```"]
34
51
},
35
52
{
36
53
"id": "DocExtractionRes.asOffline",
37
54
"kind": "value",
38
55
"name": "asOffline",
56
+ "deprecated": false,
57
+ "location": {
58
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
59
+ "line": 23,
60
+ "col": 5
61
+ },
39
62
"signature": "let asOffline: t => t",
40
63
"docstrings": ["Stuff goes offline."]
41
64
},
@@ -45,12 +68,19 @@ extracting docs for src/DocExtractionRes.res
45
68
"item":
46
69
{
47
70
"name": "SomeInnerModule",
71
+ "deprecated": false,
48
72
"docstrings": ["Another module level docstring here."],
49
73
"items": [
50
74
{
51
75
"id": "DocExtractionRes.SomeInnerModule.status",
52
76
"kind": "type",
53
77
"name": "status",
78
+ "deprecated": false,
79
+ "location": {
80
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
81
+ "line": 27,
82
+ "col": 3
83
+ },
54
84
"signature": "type status = Started(t) | Stopped | Idle",
55
85
"docstrings": [],
56
86
"detail":
@@ -59,16 +89,19 @@ extracting docs for src/DocExtractionRes.res
59
89
"constructorDocs": [
60
90
{
61
91
"constructorName": "Started",
92
+ "deprecated": false,
62
93
"docstrings": ["If this is started or not"],
63
94
"signature": "Started(t)"
64
95
},
65
96
{
66
97
"constructorName": "Stopped",
98
+ "deprecated": false,
67
99
"docstrings": ["Stopped?"],
68
100
"signature": "Stopped"
69
101
},
70
102
{
71
103
"constructorName": "Idle",
104
+ "deprecated": false,
72
105
"docstrings": ["Now idle."],
73
106
"signature": "Idle"
74
107
}]
@@ -78,13 +111,25 @@ extracting docs for src/DocExtractionRes.res
78
111
"id": "DocExtractionRes.SomeInnerModule.validInputs",
79
112
"kind": "type",
80
113
"name": "validInputs",
114
+ "deprecated": false,
115
+ "location": {
116
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
117
+ "line": 31,
118
+ "col": 3
119
+ },
81
120
"signature": "type validInputs = [\\n | #\\\"needs-escaping\\\"\\n | #something\\n | #status(status)\\n | #withPayload(int)\\n]",
82
121
"docstrings": ["These are all the valid inputs."]
83
122
},
84
123
{
85
124
"id": "DocExtractionRes.SomeInnerModule.callback",
86
125
"kind": "type",
87
126
"name": "callback",
127
+ "deprecated": false,
128
+ "location": {
129
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
130
+ "line": 33,
131
+ "col": 3
132
+ },
88
133
"signature": "type callback = (t, ~status: status) => unit",
89
134
"docstrings": []
90
135
}]
@@ -96,6 +141,7 @@ extracting docs for src/DocExtractionRes.res
96
141
"item":
97
142
{
98
143
"name": "AnotherModule",
144
+ "deprecated": false,
99
145
"docstrings": ["Mighty fine module here too!"],
100
146
"items": [
101
147
{
@@ -108,20 +154,38 @@ extracting docs for src/DocExtractionRes.res
108
154
"id": "DocExtractionRes.AnotherModule.callback",
109
155
"kind": "type",
110
156
"name": "callback",
157
+ "deprecated": false,
158
+ "location": {
159
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
160
+ "line": 44,
161
+ "col": 3
162
+ },
111
163
"signature": "type callback = SomeInnerModule.status => unit",
112
164
"docstrings": ["Testing what this looks like."]
113
165
},
114
166
{
115
167
"id": "DocExtractionRes.AnotherModule.isGoodStatus",
116
168
"kind": "value",
117
169
"name": "isGoodStatus",
170
+ "deprecated": false,
171
+ "location": {
172
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
173
+ "line": 46,
174
+ "col": 7
175
+ },
118
176
"signature": "let isGoodStatus: SomeInnerModule.status => bool",
119
177
"docstrings": []
120
178
},
121
179
{
122
180
"id": "DocExtractionRes.AnotherModule.someVariantWithInlineRecords",
123
181
"kind": "type",
124
182
"name": "someVariantWithInlineRecords",
183
+ "deprecated": false,
184
+ "location": {
185
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
186
+ "line": 49,
187
+ "col": 3
188
+ },
125
189
"signature": "type someVariantWithInlineRecords = SomeStuff({offline: bool})",
126
190
"docstrings": ["Trying how it looks with an inline record in a variant."],
127
191
"detail":
@@ -130,6 +194,7 @@ extracting docs for src/DocExtractionRes.res
130
194
"constructorDocs": [
131
195
{
132
196
"constructorName": "SomeStuff",
197
+ "deprecated": false,
133
198
"docstrings": ["This has inline records..."],
134
199
"signature": "SomeStuff"
135
200
}]
@@ -139,6 +204,12 @@ extracting docs for src/DocExtractionRes.res
139
204
"id": "DocExtractionRes.AnotherModule.domRoot",
140
205
"kind": "type",
141
206
"name": "domRoot",
207
+ "deprecated": false,
208
+ "location": {
209
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
210
+ "line": 54,
211
+ "col": 3
212
+ },
142
213
"signature": "type domRoot = unit => ReactDOM.Client.Root.t",
143
214
"docstrings": ["Callback to get the DOM root..."]
144
215
}]
@@ -150,19 +221,32 @@ extracting docs for src/DocExtractionRes.res
150
221
"item":
151
222
{
152
223
"name": "ModuleWithThingsThatShouldNotBeExported",
224
+ "deprecated": false,
153
225
"docstrings": [],
154
226
"items": [
155
227
{
156
228
"id": "DocExtractionRes.ModuleWithThingsThatShouldNotBeExported.t",
157
229
"kind": "type",
158
230
"name": "t",
231
+ "deprecated": false,
232
+ "location": {
233
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
234
+ "line": 61,
235
+ "col": 3
236
+ },
159
237
"signature": "type t",
160
238
"docstrings": ["The type t is stuff."]
161
239
},
162
240
{
163
241
"id": "DocExtractionRes.ModuleWithThingsThatShouldNotBeExported.make",
164
242
"kind": "value",
165
243
"name": "make",
244
+ "deprecated": false,
245
+ "location": {
246
+ "path": "/home/pedro/Desktop/projects/rescript-vscode/analysis/tests/src/DocExtractionRes.res",
247
+ "line": 63,
248
+ "col": 3
249
+ },
166
250
"signature": "let make: unit => t",
167
251
"docstrings": ["The maker of stuff!"]
168
252
}]
0 commit comments