lua-users home
lua-l archive

[Date Prev][Date Next][Thread Prev][Thread Next] [Date Index] [Thread Index]

There have been a few proposals fir documenting table argument fields, but nothing implemented as far as I know.  In the doc system for LuaAV, we simple write:

@param args Description
@param args.field Field description

You can see example output on our doc pages, particularly in the audio.def module:


On Sep 21, 2010, at 7:01 AM, Martin Schröder <> wrote:

> Hi,
> how do you document the named parameters of a function with luadoc?
> ---- a function
> -- @param args a table with
> -- @field foo some parameter
> -- @field bar another parameter
> doesn't produce the expected result...
> Best
>   Martin