@call_arg | Mark wrapper parameters as names, callbacks, files, or metadata | ---@[call_arg("gmod.hook", "add")] |
@adds_field | Declare a field a function adds to a table argument | ---@[adds_field("MetaID", "integer")] |
@valid_guard | Mark a function that proves its argument is valid | ---@[valid_guard] |
@self_guard | Mark a method that proves its receiver is valid | ---@[self_guard("gmod.entity")] |
@self_call_valid | Mark a callback where a self method returns a valid value | ---@[self_call_valid("GetOwner")] |
@self_class_name | Mark a method that returns the class name of the object it is called on | ---@[self_class_name] |
@exhaustive_type_guard | Mark a type check that also rules out subclasses when it fails | ---@[exhaustive_type_guard] |
@return_alias | Mark a function that returns one of its arguments unchanged | ---@[return_alias(0)] |
@copy_result | Mark a function that returns a copy of its table argument | ---@[copy_result] |
@fresh_result | Mark a method that returns a new value on every call | ---@[fresh_result] |
@writes_global | Declare the only globals a function changes | ---@[writes_global("ConVarCache")] |
@net_send | Mark a function that sends the current net message | ---@[net_send("client")] |
@net_payload | Mark a function that writes or reads a net message value | ---@[net_payload("write", "string")] |
@builtin_alias | Keep a Lua built-in’s handling on a replacement | ---@[builtin_alias("pairs")] |
@meta | Mark a file as type-only (not runtime) | ---@meta |
@module | Declare a file as a named module | ---@module mymodule |
@source | Map a definition to its true source location | ---@source file:///path/file.lua#41:0 |