LDoc Alternatives
LDoc
LDoc is Lua documentation generator intended to be compatible with LuaDoc 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.
Best Open Source LDoc Alternatives
Looking for a program that is like LDoc? We have our top picks here. If you need another program that has some of the features of LDoc on your device, read what we recommend in this post.
Doxygen
FreeOpen SourceMacWindowsLinuxHaikuDoxygen is a tool for generating documentation from annotated C++ sources, as well as other popular programming languages like C, Objective-C, C#, PHP, Java, Python, IDL...
Sphinx
FreeOpen SourceMacWindowsLinuxPythonSphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.
Features:
- Documentation
- Python
swagger.io
FreeOpen SourceMacWindowsLinuxWebNode.JSSwagger is an open source RESTapi Documentation Tool.
Slate API Docs Generator
FreeOpen SourceMacLinuxSelf-HostedSlate - beautiful static documentation for your API. Features Clean, intuitive design — With Slate, the description of your API is on the left side of your...
Daux.io
FreeOpen SourceSelf-HostedDaux.io is a documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking...
Features:
- Documentation
- MarkDown support
- Php
Presidium
FreeOpen SourceMacLinuxGitHub PagesPresidium is a software documentation management system for agile teams, and their users, made from commonly used open source components.
ApiGen
FreeOpen SourceMacWindowsLinuxApiGen is the tool for creating professional API documentation from PHP source code, similar to phpDocumentor 2 . ApiGen has support for PHP 5.
DocFX
FreeOpen SourceMacWindowsLinuxDocFX generates Documentation directly from source code (.NET, RESTful API, JavaScript, Java, etc...) and Markdown files. DocFX runs on Linux, macOS, and Windows. The...
Features:
- Self-hosted in intranet or private cloud
- Documentation
Upvote Comparison
Interest Trends
LDoc Reviews
Add your reviews & share your experience when using LDoc to the world. Your opinion will be useful to others who are looking for the best LDoc alternatives.