lua-users home
lua-l archive

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

On Sun, Jun 11, 2017 at 7:17 PM, Charles Heywood <> wrote:
> I try to document what types *should* be passed to functions, which means I
> make heavy use of typed argument and typed return values, but I don't think
> I brew too much @-soup when programming besides that.

That's the important part, I think. @usage is often helpful, but
having type in some _structured_ form in the doc comments not only
help the human consumers of the API, but might be used by some
automatic tools as well.  I think this is done by the Lua Eclipse
plugin, but in their wisdom they chose a format which is not quite
ldoc compatible.