Skip to main content

​
Overview

@see adds a cross-reference link to another symbol, class, or function. Hover documentation shows the reference so you can jump to related APIs.

​
Syntax

---@see SymbolName
---@see SymbolName Description

​
Referencing another function

---@see ValidateData For input validation
---@see FormatOutput For result formatting
function ProcessData(data)
    local validated = ValidateData(data)
    return FormatOutput(validated)
end

​
Referencing a class

---@class User
---@field id number
---@field name string
---@see UserManager
---@see UserValidator
local User = {}

​
Multiple references

---@see Entity:GetPos Returns entity position
---@see Entity:SetPos Sets entity position
---@see Entity:GetAngles Related angle accessor
function Entity:GetTransform() end

​
When to use @see

  • Link related functions you use together
  • Point to the replacement for a deprecated function
  • Reference documentation or GMod Wiki pages (use full URL or descriptor)