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...
This PR fixes and corrects the broken link to the `ldoc` .zip-file given mentioned in `ldoc.lua`. It also corrects several typos in the documentation an din source files.
This PR adds a test using the `@type` tag in both a `@module` and `@submodule`. It shows that the generated docs are different for both cases: `Type2InModule` is properly shown...
**My setup:** I have a project where I provide several modules consisting of multiple classes. Each class is implemented in its own file and documented using @type. For each module,...
Fixed: `/usr/local/share/lua/5.1/ldoc/markup.lua:159: attempt to index local 'line' (a nil value)` By adding a check enclosing all the lines that play with line making sure is not nil I Don't know...
Unfortunately documentation tagging systems have proliferated and fragmented. The current pretty *de facto* Lua Language Server (Sumneko) uses the [LuaCATS annotation system](https://luals.github.io/wiki/annotations/) which are derived from [EmmyLua annotations](https://emmylua.github.io/annotation.html) which are...
ldoc has support of subparams (even though the feature is a bit hidden): https://github.com/lunarmodules/ldoc/blob/e4940daf748affb86489b0782ed8abab2e88bebc/tests/styles/subparams.lua#L8-L13 Since Lua does not have support of named params, it is not rare to have multiple...
Words like `package`, `type`, `string` are linked to the Lua manual even when it makes no sense at all.
I was wondering if you can add support for the `hxx` file extension in the next release, thanks.
Error message on invalid tag somewhat obtuse and doesn't point out the issue being the undefined tag
This error happens even if there's no actual file being processed (i.e. all files are `no module() call found; no initial doc comment`). The error happens when executing `ldoc `....
Would be cool if something like this would work: --- Captures location in source code at given call stack level. -- @see debug.getinfo local capture_source_location = function( level -- @number[opt=1]...
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...