LuaDoc: Documentation Generator Tool for the Lua language

LuaDoc
Documentation Generator Tool for the Lua language

## Overview

LuaDoc is a documentation generator tool for Lua source code. It parses the declarations and documentation comments in a set of Lua source files and produces a set of XHTML pages describing the commented declarations and functions.

The output is not limited to XHTML. Other formats can be generated by implementing new `doclets`. The format of the documentation comments is also flexible and can be customized by implementing new `taglets`. Please refer to customizing section for further information.

LuaDoc is free software and uses the same license as Lua.

## Status

Current version is 3.0.1. It was developed for Lua 5.1.

## Download

LuaDoc can be downloaded from its Lua Forge page.

## Dependencies

LuaDoc depends on two external packages:

- LuaFileSystem 1.2
- LuaLogging 1.1 (optional)

## History

Version 3.0.1 [17/Feb/2008]
  - added support to @usage tags (thanks to Rafael Sabbagh Armony)
  - makefile improved to follow kepler standards
  - lualogging dependency is now optional
  - added a rockspec file
Version 3.0.0 [13/Aug/2007]
  - update to Lua 5.1
  - major internal refactoring
Version 2.0 [14/Aug/2002]
  - update to Lua 4.0
Version 1.1 [31/Mar/1999]
  - "DOS/Windows"-safe sources (no problems with "`\r\n`" line-breaks)
  - new `usage` subsection
Version 1.0 [15/Mar/1999]

## Credits

LuaDoc codebase was designed and developed by Tomás Guisasola. Version 3.0 was refactored by Danilo Tuler and Tomás Guisasola as part of the Kepler Project, which holds its copyright.

## Contact us

For more information please contact us or join the Kepler mailing list. Comments are welcome!

$Id: index.html,v 1.19 2008/02/17 06:42:51 jasonsantos Exp $