On Wed, Sep 30, 2009 at 5:21 PM, Wesley Smith wrote:
> -- @param init.value1 Description 1
> -- @param init.value2 Description 2
> function my_constructor(init)
That would be a useful addition, since it's a common pattern and hard
to document currently.
While we are on the subject of LuaDoc, it
>> I would propose
>>
>> ---
>> -- @param init.value1 Description 1
>> -- @param init.value2 Description 2
>> function my_constructor(init)
>>
> Thanks! Do you have a proposal to what output the above descriptions
> might be converted to?
>
param = {
[1] = "init",
init = {
value1
Hi Wesley
Is there a standard for documenting the arguments to tables as
function arguments?
This is in my todo-list for years :-) Unfortunatelly I have
never had the time to spend on it :-(
Some examples I have used:
-- @param t IUP element and other configuration (wh
Is there a standard for documenting the arguments to tables as
function arguments? for example
function my_constructor(init)
-- use init table to set variables of object we're going to create
local m = {}
-- set m with init fields
return m
end
my_constructor{
key1 = value1,
key2 = value2
