Eclipse Community Forums: Koneki » How to document the return type of a module's _

Help

Home

Home » Archived » Koneki » How to document the return type of a module's __call metamethod ?

Show: Today's Messages :: Show Polls :: Message Navigator

How to document the return type of a module's __call metamethod ? [message #1416540]

Fri, 27 July 2012 05:42

Cheyi Lin

Messages: 16
Registered: June 2012

Junior Member

Hi,

How do I document the return type of a module's __call metamethod ?

----
-- @module mymodule
local m = {}

----
-- @type mytype

----
-- mytype.number_field
-- @field [parent=#mytype] #number number_field

----
-- mytype.string_field
-- @field [parent=#mytype] #string string_field

local function mytype(t)
return {number_field=1, string_field="hello"}
end

setmetatable(m, {__call=mytype})

return m

Report message to a moderator