Re: Function arguments in luadoc

[steve donovan <steve.j.donovan@...>]

On Fri, May 20, 2011 at 12:55 AM, Reuben Thomas <rrt@sc3d.org> wrote:
> Is there some way to describe the parameters and return values of
> function arguments to other functions in luadoc? I'm luadoc-ifying the

The only way I know to document a returned _table_ is  to make some
documentation for a named table:

-- @class table
-- @name node_returns
-- @field f: iterator function
-- @field n: current node
-- @field p: path to node within the tree

and then in the docs for node do a @see node_returns

For multiple values returned, the convention is to have multiple @return tags.

The yield case has to be handled in a similar fashion - i.e. one
declares a phony function with the right return values and refers to
it.

Not exactly elegant, and a common enough case to inspire some
rethinking perhaps?

steve d.