How to Document Module's Local Function [message #966311] |
Wed, 31 October 2012 18:55  |
Eclipse User |
|
|
|
I am new in Koneki/LDT and am insterested that I can make Lua "strict" with Documentation Language of Koneki/LDT.
In http://wiki.eclipse.org/Koneki/LDT/Technical_Documentation/Documentation_Language#Function_comment_block, it said that:
Quote:The function comment block has to be attached to a type.
So, how do I write documentation for local function? For example, how to fill "???" in codes like this:
---
-- @module supermodule.mymodule
local mymodule = {}
---
-- Actually I'm not sure whether to write `#(supermodule.mymodule)` or
-- just `#supermodule.mymodule`.
--
-- @function [parent=#(supermodule.mymodule)] interface
function mymodule.interface( foo )
end
---
-- @function [parent=???] internal
local function internal( bar )
end
return mymodule
Thank you
|
|
|
|
|
Powered by
FUDForum. Page generated in 0.03022 seconds