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...
LDoc can't handle non-alphanums in @fields, here: http://rrthomas.github.io/lua-stdlib/modules/std.functional.html#op Notice all the actual field names are missing, compared to: https://github.com/rrthomas/lua-stdlib/blob/master/ext/std/functional.lua#L176 I would also have liked to document metamethods according to their...
I'm working on documentation for [luabnet_tools](https://github.com/Choonster/luabnet_tools) and I'm trying to document a Proxy type that doesn't have any methods. Currently LDoc doesn't output anything about this type because it doesn't...
With recent updates, I explicitly list @classmod files in topological order, and that is correctly reflected in generated index.html (with `std.object` base object first): http://rrthomas.github.io/lua-stdlib/ Also, pages in `modules/*.html` are...
I played a bit around with @set sort and the sort option in config.ld, and it doesn't appear to accept functions in the ways I tried. The documentation only mentions...
The "Contents" section changes in size: on the Index site it isn't even visible at all, then suddenly pops in on the module sub sites when navigating around, pushing "Modules"...
I can't see how to tell LDoc that I'm writing a single module, and so having a "modules" section seems kind of weird. Also, what are "topics"? Is an introduction...
I guess, `white-space: nowrap;` is missing somewhere. See screenshot: 
Currently two `@return` tags yield text that can be read as mutltiple return values documentation (i.e. _and_). Functions that can return different things depending on the situation are not that...
The function tag does not support tag modifier. If I run ldoc on this code : ``` lua --- -- @function[foo=bar] myfunc -- My func is a great function local...
We're iteratively documenting our Katamari: https://github.com/lua-nucleo/lua-nucleo/ As you can see, there is a lot of empty pages in the documentation. We'd like to see at least list of names of...
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...