summaryrefslogtreecommitdiff
path: root/test/diagnostics/missing-global-doc.lua
blob: 2ebc237ae8f9eb2a8f0d28a236b3bac382b0e0e5 (plain)
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
local config = require 'config'
local util   = require 'utility'

-- disable all default groups to make isolated tests
config.set(nil, 'Lua.diagnostics.groupFileStatus',
{
    ['ambiguity']     = 'None',
    ['await']         = 'None',
    ['codestyle']     = 'None',
    ['conventions']   = 'None',
    ['duplicate']     = 'None',
    ['global']        = 'None',
    ['luadoc']        = 'None',
    ['redefined']     = 'None',
    ['strict']        = 'None',
    ['strong']        = 'None',
    ['type-check']    = 'None',
    ['unbalanced']    = 'None',
    ['unused']        = 'None'
})

-- enable single diagnostic that is to be tested
config.set(nil, 'Lua.diagnostics.neededFileStatus',
{
    ['missing-global-doc'] = 'Any!' -- override groupFileStatus
})


-- check global functions
TEST [[
<!function FG0()
end!>

---comment
function FG1()
end
]]

TEST [[
function FGP0(<!p!>)
  print(p)
end

---comment
function FGP1(<!p!>)
  print(p)
end

---comment
---@param p any
function FGP2(p)
  print(p)
end
]]

TEST [[
function FGPP0(<!p0!>, <!p1!>)
  print(p0, p1)
end

---comment
function FGPP1(<!p0!>, <!p1!>)
  print(p0, p1)
end

---comment
---@param p0 any
function FGPP2(p0, <!p1!>)
  print(p0, p1)
end

---comment
---@param p0 any
---@param p1 any
function FGPP3(p0, p1)
  print(p0, p1)
end
]]

TEST [[
function FGR0()
  return <!0!>
end

---comment
function FGR1()
  return <!0!>
end

---comment
---@return integer
function FGR2()
  return 0
end
]]

TEST [[
function FGRR0()
  return <!0!>, <!1!>
end

---comment
function FGRR1()
  return <!0!>, <!1!>
end

---comment
---@return integer
function FGRR2()
  return 0, <!1!>
end

---comment
---@return integer
---@return integer
function FGRR3()
  return 0, 1
end
]]


TEST [[
function FGPR0(<!p!>)
  print(p)
  return <!0!>
end

---comment
function FGPR1(<!p!>)
  print(p)
  return <!0!>
end

---comment
---@param p any
function FGPR2(p)
  print(p)
  return <!0!>
end

---comment
---@return integer
function FGPR3(<!p!>)
  print(p)
  return 0
end

---comment
---@param p any
---@return integer
function FGPR4(p)
  print(p)
  return 0
end
]]

-- check local functions

TEST [[
local function FL0()
end

FL0()

---comment
local function FL1()
end

FL1()
]]

TEST [[
local function FLP0(p)
  print(p)
end

FLP0(0)

---comment
local function FLP1(p)
  print(p)
end

FLP1(0)

---comment
---@param p any
local function FLP2(p)
  print(p)
end

FLP2(0)
]]

TEST [[
local function FLPP0(p0, p1)
  print(p0, p1)
end

FLPP0(0, 1)

---comment
local function FLPP1(p0, p1)
  print(p0, p1)
end

FLPP1(0, 1)

---comment
---@param p0 any
local function FLPP2(p0, p1)
  print(p0, p1)
end

FLPP2(0, 1)

---comment
---@param p0 any
---@param p1 any
local function FLPP3(p0, p1)
  print(p0, p1)
end

FLPP3(0, 1)
]]

TEST [[
local function FLR0()
  return 0
end

local vr0 = FLR0()

---comment
local function FLR1()
  return 0
end

local vr1 = FLR1()

---comment
---@return integer
local function FLR2()
  return 0
end

local vr2 = FLR2()
]]

TEST [[
local function FLRR0()
  return 0, 1
end

local vrr0, _ = FLRR0()

---comment
local function FLRR1()
  return 0, 1
end

local vrr1, _ = FLRR1()

---comment
---@return integer
local function FLRR2()
  return 0, 1
end

local vrr2, _ = FLRR2()

---comment
---@return integer
---@return integer
local function FLRR3()
  return 0, 1
end

local vrr3, _ = FLRR3()
]]

TEST [[
local function FLPR0(p)
  print(p)
  return 0
end

local vpr0 = FLPR0(0)

---comment
local function FLPR1(p)
  print(p)
  return 0
end

local vpr1 = FLPR1(0)

---comment
---@param p any
local function FLPR2(p)
  print(p)
  return 0
end

local vpr2 = FLPR2(0)

---comment
---@return integer
local function FLPR3(p)
  print(p)
  return 0
end

local vpr3 = FLPR3(0)

---comment
---@param p any
---@return integer
local function FLPR4(p)
  print(p)
  return 0
end

local vpr4 = FLPR4(0)
]]

-- reset configurations
config.set(nil, 'Lua.diagnostics.groupFileStatus',
{})
config.set(nil, 'Lua.diagnostics.neededFileStatus',
{})
config.set(nil, 'Lua.diagnostics.globals',
{})