Eclipse Community Forums: Koneki » How to Document Module's Local Function

Help

Home

Home » Archived » Koneki » How to Document Module's Local Function

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

How to Document Module's Local Function [message #1416724]

Thu, 01 November 2012 12:35

Born To Code

Messages: 4
Registered: October 2012

Junior Member

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

Report message to a moderator

Re: How to Document Module's Local Function [message #1416729 is a reply to message #1416724]

Mon, 05 November 2012 10:26

Kevin KIN-FOO

Messages: 28
Registered: July 2009

Junior Member

Hi,

For the parent type name it is:
---
-- Actually, write `#supermodule.mymodule`.
--
-- @function [parent=#supermodule.mymodule] interface
-- @param foo
function mymodule.interface( foo )
end
I updated the documentation which was not clear enough about this.
The aim of LDD is to let you describe the API exposed by your module.
So far there is no way to document for an "inside-module only" use, but I get your need.
We will keep you posted as soon as we have something about this purpose.

Kevin

Report message to a moderator