lua-users home
lua-l archive

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


Hi,

I'm reworking the documentation for the open source game Bitfighter (bitfighter.org), which uses Lua scripting to support a number of different functions.  I'm having trouble conveying the information I want, and am looking for good examples of effective Lua API documentation.

My specific issues are how to express argument and return types, as Lua does not have a natural way to do this (documenting C++ or Python functions is much easier in this regard).  I know what information I need to show, but not how to show it.

Pointers to good examples would be most welcome.

Thank you!

Chris