How to document a closure with LuaDoc?

Question

Suppose I have a function that returns a closure:

--- Agent constructor
-- @return A function describing the behavior of the agent
Agent = function(data)
   return function(arg1, arg2, ...) end
end

And then I have a variable that receives that closure:

SugarAgent = Agent{ metabolism=5, health=3 }

Is there a standard way in LuaDoc to document the above construction?

Can you give an example of what the doc would be – Oliver Mar 10 '14 at 00:55 — Oliver, Mar 10 '14 at 00:55

Colonel Thirty Two · Accepted Answer · 2014-03-12T14:17:06.037

1

You can do it by specifying the doc name and type manually:

--- This is a SugarAgent
-- @name SugarAgent
-- @class function
-- @return Some value
SugarAgent = Agent{ metabolism=5, health=3 }

edited Mar 12 '14 at 14:17

answered Mar 08 '14 at 19:09

I'm actually trying to document the AgentSugar function, but your answer came pretty close to what I'm looking for. – Daniel Mar 10 '14 at 13:32
Sorry, it's actually `@class`, not `@type` (see http://keplerproject.github.io/luadoc/manual.html#tags). Someone tried to edit the post with the correct information, but the edit was rejected because it was 'incorrect.' Sigh. – Colonel Thirty Two Mar 12 '14 at 14:14

1 Answers1