Lua Documentation

I’ve been playing around with different methods for Lua documentation today. Took me a bit of time to get into the lua method of doing stuff, and I still haven’t quite worked out LuaRocks yet (nothing seems to install). However, using a combination of apt-get, LuaRocks and a bit of manual “Gittery” I managed to get both LuaDoc and LDoc installed.

After some tweaking, and rewriting of the inline docs to suit conventions, I think I prefer LDoc. Out the box it seems much more clean and I really like that fact that Markdown was so easy to set up.

Below you can see examples of the two different outputs from LuaDoc and LDoc respectively.


Example of Lua documentation using LuaDoc

Example of Lua documentation using LDoc