Re: luadoc: best way to handle table parameters?

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

On Sun, Jun 12, 2011 at 12:27 AM, David Hollander <dhllndr@gmail.com> wrote:
> Hello, I was wondering how luadoc users recommend handling tables as parameters.

This is definitely one of those things that people want to do, e.g. recently:

http://lua-users.org/lists/lua-l/2011-05/msg00509.html

And I agree, embedding HTML in comments is ugly.

The work-around I suggested involved documenting the parameter table
structure explicitly - that is, defining a @class table and filling in
the @field values. And then doing a @see reference to that named
table.

Personally, I think markdown is the way to go ;)  ldoc should be ready
for beta in a few days.

steve d.