A documentation example is LuaDoc own source code and the generated documentation.
The source code can be browsed from the
CVS repository. The generated
documentation can be browsed online.
You can also document a Lua library which is written in C. To do that simply write a file
.luadoc extension and define the function prototypes with
the documentation comments. This file will be parsed by LuaDoc and the documentation
will be generated.
As an example the LuaFileSystem
API was defined in a file called
The generated documentation can be browsed online.