LDoc

What is LDoc?

The LDoc tool is a Lua documentation generator designed to be compatible with the existing LuaDoc format. It follows the established patterns of similar documentation tools, allowing developers to generate comprehensive documentation for their Lua projects. LDoc offers enhanced diagnostics, improved support for module declarations, and the ability to use Markdown syntax instead of embedded HTML in code comments. Additionally, LDoc can handle Lua C extension code, providing convenient shortcuts to streamline the documentation process

Highlights

• Compatibility with the LuaDoc format, following established documentation patterns
• Enhanced diagnostics, including line numbers for missing see references
• Support for modules that do not use the deprecated module() function
• Ability to use Markdown syntax instead of embedded HTML in comments
• Capabilities for documenting Lua C extension code with convenient shortcuts