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...
### Code ``` --- -- A Class Module -- @classmod ClassModule local ClassModule = {} --- Create a new ClassModule -- @return a new ClassModule object function ClassModule.new() return nil...
In a comment with `@usage`, all white-space from right after the double-dash is added to the rendered source code in documentation. This prevents clean copy&paste and also prevents developers from...
``` /*** * @file * @ingroup LUA * @module REGISTRY */ ``` Something like this would be nice - but right now it just errors out with unknown tag and...
https://github.com/stevedonovan/LDoc/commit/607b5cf4c64309c4c0cbeae000a19da0586ee209 (`globals _G and _VERSION are _tables_`) and Lua disagree with each other: ``` $ lua -e 'print(type(_VERSION))' string ``` I don't think `_VERSION` is a table.
i write a lot of object oriented Lua and i would like for a @module to _pull_ in content from multiple files (i.e., the superclasses). as it stands, with the...
builtin/globals.lua is nice, thank you. `@{require}` yields the desired link to the Lua Reference Manual, but I'd like to render the function name "require" inside an HTML code element, so...
It just ignores the index number and resolves modifiers in a random order. See [Item.check_tag in doc.lua](https://github.com/stevedonovan/LDoc/blob/2241932602379fb8eb369cebe4929bcd275b45c4/ldoc/doc.lua#L539-L545): ``` lua for m,v in pairs(amod) do local idx = v:match('^%$(%d+)') if idx...
Running LDoc always leaves a /tmp/ldoc directory, which prevents other users from running ldoc until that directory is manually removed due to `cannot write to /tmp/ldoc` error. LDoc should certainly...
 As you can see, the `usage` tag is adding extra lines to my code block (actual extra lines, not just double-spaced lines). ``` lua -- @usage -- -- Create...
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...