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...
The constructors in Moonscript classes is defined as `Class\new`. However, that constructor is NEVER called as `Class\new ...` and always as `Class ...`. Showing the constructor as a method in...
The `tests/moonscript/List.moon` example works fine to show the problem. The generated anchors in the documentation will be `List\new`, `List\add`, and so on. But those are invalid HTML ids and therefor...
I love the simplicity of LDoc. I currently use Doxygen for my Python projects, but was wondering how difficult it would be to add Python support to LDoc. I think...
This is part of my ***config.ld***: ```lua new_type('chatcmd', 'Chat Commands', false, 'chatparam') custom_tags = { {'chatparam', title='Parameters',}, } local function chatcmd_handler(item) local output = item.name for i, p in ipairs(item.tags.chatparam)...
I have a tableconstructor-returning config file written in moonscript (though this seems to apply to lua as well), in the style: ```moonscript --- @module myapplication.config { some_variable: 5 some_section: {...
According to the [documentation on Sections](https://stevedonovan.github.io/ldoc/manual/doc.md.html#Sections), a `@section` command has a domain that extends until the next `@section` block (with `@section end` being a special end tag that reverts to...
When using "Functions" as section title, with `@within`, I got this: ``` /home/pedroalves/Desktop/ex.lua:28: internal LDoc error /usr/local/share/lua/5.3/ldoc/tools.lua:111: table index is nil stack traceback: /usr/local/share/lua/5.3/ldoc/tools.lua:111: in method 'add' /usr/local/share/lua/5.3/ldoc/doc.lua:399: in method...
When a method has only one parameter (self), it is being displayed explicitly in the argument list and with the object notation. This combination is an invalid syntax. The test...
The tag for generated HTML pages should include the title for the specific page. For example, a page such be titled as "posix.sys.stat - luaposix 33.4.0 Reference" instead of the...
I am trying to generate a documentation for https://github.com/FAForever/fa/tree/develop/lua To do so I am running from within `E:\git\faforever\fa` ldoc lua -d E:\git\faforever\fa-lua-doc\ but all I get is: e:\git\faforever\fa\lua\aeon_naval_weapons.lua:1: contains no...
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...