--- this is a description
---     even preserves formatting
---@param param1 string this is a parameter description
---@param param2 table|nil this parameter has two possible types
---@param param3 string|nil|number|table this is also possible
---@return string of course there is a return type
---@return table|number even allows a second return value
---@example print("examples")
---@example print("go here")
---@explanation prints:
---@explanation examples
---@explanation go here
---@see example example this links back to this file
function someMethod(param1, param2, param3)
    --just imagine there is some code here that makes it work
    return aString, tableOrNumber
end

print("examples")
print("go here")

---@param <name> <type> <description>

---@param fileName string this is the file this functions scans

---@param tags table|nil a table of tags you would like to add can also be nil

---@return <tape> <name> <description>

---@return number temp this is the temperature calculated

---@return number temp this is the temperature calculated
---@return string|nil state this is the state of the matirale at that temp

---@example <lua line>

--@example --use methods like this
--@example local value = myFunc(io.read())

---@explanation <some text explaining the code chunk above>

---@explanation in the example we get a value from the user and process it in myFunc

vairable = function() end

local table = {}

function table.method()
end