Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Archived » Koneki » How to Document Module's Local Function
How to Document Module's Local Function [message #1416724] Thu, 01 November 2012 12:35 Go to next message
Born To Code is currently offline Born To CodeFriend
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
Re: How to Document Module's Local Function [message #1416729 is a reply to message #1416724] Mon, 05 November 2012 10:26 Go to previous messageGo to next message
Kevin KIN-FOO is currently offline Kevin KIN-FOOFriend
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
Re: How to Document Module's Local Function [message #1416732 is a reply to message #1416729] Tue, 06 November 2012 05:44 Go to previous message
Born To Code is currently offline Born To CodeFriend
Messages: 4
Registered: October 2012
Junior Member
Thank you Kevin.
I think documentation for internal function/field is good to make Eclipse's Outline tree cleaner, and helps me too :).
Previous Topic:Gideros Code Assist
Next Topic:External Lib : Lua LOOP not running
Goto Forum:
  


Current Time: Sun Nov 18 01:46:57 GMT 2018

Powered by FUDForum. Page generated in 0.02761 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top