Как задокументировать закрытие с LuaDoc?

Question

Предположим, у меня есть функция, которая возвращает замыкание:

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

И тогда у меня есть переменная, которая получает это закрытие:

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

Есть ли в LuaDoc стандартный способ документировать вышеуказанную конструкцию?

Answer 1

Вы можете сделать это, указав имя и тип документа вручную:

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

См. http://keplerproject.github.io/luadoc/manual.html