Select your language

Home arrow-right ... arrow-right Development Tools arrow-right LDoc

We've compiled a list of 27 free and paid alternatives to LDoc. The primary competitors include Doxygen, swagger.io. In addition to these, users also draw comparisons between LDoc and Sphinx, Natural Docs, Daux.io. Also you can look at other similar options here: Development Tools.


Doxygen
Free Open Source

Doxygen is a tool for generating documentation from annotated C++ sources, as well as other popular...

swagger.io
Free Open Source

Swagger is an open source RESTapi Documentation Tool.

Sphinx
Free Open Source

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by...

Natural Docs is an open-source documentation generator for multiple programming languages.

Daux.io
Free Open Source

Daux.io is a documentation generator that uses a simple folder structure and Markdown files to...

Javadoc is a tool from Sun Microsystems for generating API documentation in HTML format from doc...

Sandcastle
Free Open Source

Sandcastle produces accurate, MSDN style, comprehensive documentation by reflecting over the source...

A Lua documentation generator

LDoc Platforms

tick-square Windows
tick-square Linux

LDoc Overview

LDoc is Small Lua iconLua documentation generator intended to be compatible with Small LuaDoc iconLuaDoc and thus follows the pattern set by the various Doc tools:

--- Summary ends with a period.
-- Some description, can be over several lines.
-- @param p1 first parameter
-- @param p2 second parameter
-- @return a string value
-- @see second_fun
function mod1.first_fun(p1,p2)
end

Tags such as see and usage are supported, and generally the names of functions and modules can be inferred from the code.

LDoc is designed to give better diagnostics: if a @see reference cannot be found, then the line number of the reference is given. LDoc knows about modules which do not use module(). This is important since this function has become deprecated in Lua 5.2. And you can avoid having to embed HTML in commments by using Markdown.

LDoc will also work with Lua C extension code, and provides some convenient shortcuts.

Share your opinion about the software, leave a review and help make it even better!

LDoc Categories

Development Tools

LDoc Tags

lua-documentation lua-docs lua-doc lua documentation-generator

Suggest Changes

Your Feedback

Select a rating
Please select a rating

Your vote has been counted.

Do you have experience using this software?