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 (which are deleted from it):
-- labelbgcolor, labelfgcolor, label, labelsize, labeltip, labeltitle,
-- halignment
-- @param ... IUP elements to be inserted in the same IUPHBox.
-- @param desc Table describing the list, which should have the fields
-- label, ids (which is a table doubly indexed) and the usual IUP fields.
-- @param element IUP handle of the element to clear (it must have a .value).
-- @param userid Table with field object, which is a command box.
I would propose
---
-- @param init.value1 Description 1
-- @param init.value2 Description 2
function my_constructor(init)
or
---
-- @field init.value1 Description 1
-- @field init.value2 Description 2
function my_constructor(init)
Thanks! Do you have a proposal to what output the above descriptions
might be converted to?
Regards,
Tomás_______________________________________________
Kepler-Project mailing list
Kepler-Project@lists.luaforge.net
http://lists.luaforge.net/cgi-bin/mailman/listinfo/kepler-project
http://www.keplerproject.org/
