[Need Explain] Parameter type

[ckysmrn]

I has define self as toknzr.Virtual (at line 26)
but I getting warn at line 30
Why?

[tomlau10]

IIUC, defining self as the class type is not enough, this is just like a @type.
In order to fulfill the visibility check of LuaLS, you need the @class attribute on the variable / object.

---@param self toknzr.Virtual
---@return string char
local function cursor_next(self)
    ---@class toknzr.Virtual # need this line, to mark `cursor` variable with the `class` attribute
    local cursor = self
    local c = cursor.source[cursor.source_pos] --> no more warning
    return c
end

---

You may wonder why a standard function MyClass:method() won't trigger this warning even without explicitly marking self with @class.
It's because the MyClass namespace is usually defined with @class already
=> so the self there already has class attribute.

---@class MyClass
---@field protected a string
local MyClass = {}

function MyClass:f1()
    print(self.a)   -- ok
end

---@param self MyClass
local function f2(self)
    print(self.a)   -- warning
end

---@param self MyClass
local function f3(self)
    ---@class MyClass
    local self = self
    print(self.a)   -- ok
end