LDoc

 Like

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

License model

  • FreeOpen Source

Application type

Platforms

  • Windows
  • Linux
  • BSD
  • Lua
  No rating
0likes
0comments
0news articles

Features

Suggest and vote on features
No features, maybe you want to suggest one?

 Tags

  • lua
  • lua-docs
  • lua-doc
  • lua-documentation

LDoc News & Activities

Highlights All activities

Recent activities

No activities found.

LDoc information

  • Developed by

    Steve J. Donovan
  • Licensing

    Open Source and Free product.
  • Written in

  • Alternatives

    31 alternatives listed
  • Supported Languages

    • English

AlternativeTo Category

Development

GitHub repository

  •  823 Stars
  •  175 Forks
  •  106 Open Issues
  •   Updated Jul 22, 2024 
View on GitHub

Popular alternatives

View all

Our users have written 0 comments and reviews about LDoc, and it has gotten 0 likes

LDoc was added to AlternativeTo by AntumDeluge on Jul 26, 2017 and this page was last updated Feb 14, 2022.
No comments or reviews, maybe you want to be first?
Post comment/review

What is LDoc?

LDoc is Lua icon Lua documentation generator intended to be compatible with LuaDoc icon 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.

Official Links