Here's some notes on documenting Lua code:
- [LuaDoc] - documentation generator tool for Lua source code, in the style of Javadoc. Fairly popular.
- For the external API + user documentation, there is an HTML+CSS style popularized by Kepler - see [luafilesystem] as an example.
- ExpLua - code comment format and a tool for extracting said comments and exporting HTML, LaTeX, and whatnot
- [LuaPOD] - translates a POD file into HTML using Lua and the LPeg library.
- LuaStyleGuide - has a few notes on commenting
- DecoratorsAndDocstrings - associate documentation with objects at runtime
FindPage · RecentChanges · preferences
edit · history
Last edited September 22, 2009 1:36 am GMT (diff)
