ldoc
ldoc copied to clipboard
lunarmodules
LDoc is a LuaDoc-compatible documentation generator which can also process C extension source. Markdown may be optionally used to render comments, as well as integrated readme documentation and pretty...
Thanks for Ldoc which is quite useful :) I can't find a way to add descriptions to examples file : a table is displayed but what ever I put in...
Take the following code (only ldoc comments, no lua code inside): ```lua ------------------------------ -- My example module -- @module example ------------------------------ -- My example class -- @type myclass ------------------------------ --...
When I'm adding a documentation where either a function refers to a `@field` of a local table or to a `@field` of a table in another module, I get the...
I have a simple module ``` return { CONST1 = 'value1', CONST2 = 'value2', } ``` and I need to describe what `CONST1` and `CONST2` fields store and how they...
Hoping this is a more acceptable solution than #308. This adds an `import` function which is enabled with the `UNSAFE_NO_SANDBOX` command line flag & is used to access built-in Lua...
**Windows 10** **Lua 5.3** ``` luarocks install --tree c:/lua ldoc Installing https://luarocks.org/ldoc-1.4.6-2.rockspec ldoc 1.4.6-2 depends on penlight (1.11.0-1 installed) ldoc 1.4.6-2 depends on markdown (0.33-1 installed) Usage: luarocks [-h] [--version]...
Inspired by something I stumbled on - https://dev.fandom.com/wiki/Global_Lua_Modules/Docbunto#Tags Tags that could be added: - `@member`/`@property` for class members - `@variable` for local variables (accepts type) - `@note` developer notes -...
Related #332. Builds docs to the gh-pages branch on every push to master. Also updates all dead links to point to live ones (or ones that will be live after...
Adds option `favicon` that can be added to config to link to an image that browsers will display as each page's icon. Example usage: ```lua project = "minetest_mod" title =...
Metadata
Owner
Metadata
LDoc is a LuaDoc-compatible documentation generator which can also process C extension source. Markdown may be optionally used to render comments, as well as integrated readme documentation and pretty...