ldoc
ldoc copied to clipboard
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...
I am having a bit of an issue here where I have a Lua module that has a basic plugin system that simply loads the plugin into a local variable...
It would be useful if `ldoc` could exit with a non-zero return code in case of errors like `param and formal argument name mismatch`. This could be used in CI...
Hi, I am trying to utilize custom_display_name_handler in my config.ld with no success, because string library is not available within config.ld. Attempt to call string.format or string.sub causes ldoc failure:...
When explicitly passing an option such as `--style`, I believe it should take precedence over the default in `config.ld`. It's arguably a matter of opinion, but it seems to me...
When I have documented Lua table I can reference it with @{} and links are correctly generated, example: ``` lua --- My module -- @module mymodule --- Test function with...
Hello, a simple search function would do wonders for usability. Something like naturaldocs' search would be fine. Here's an example. http://www.naturaldocs.org/documentation/html/files/NaturalDocs-.html
Hi there! It seems, there is a few bugs in the doc.md: 1) it links to `@list.moon`, while there is only `List.moon`. That leads to ``` doc/doc.md:725: module not found:...
After version 1.4.2, any field comments don't seem to be rendering. --- My Table -- @string my_param This text here is not rendering after 1.4.2 -- @table my_table Best.
A one can get a simple testcase for that, by extending the submodule test like this: ``` diff diff --git a/tests/submodule/config.ld b/tests/submodule/config.ld index 598ee06a8c91..42f7ed19e40a 100644 --- a/tests/submodule/config.ld +++ b/tests/submodule/config.ld @@...
After a recent commit ldoc has two new files: ldoc/html/_code_css.lua ldoc/html/_reset_css.lua They should be listed in some .rockspec file as well. I didn't know what procedure you follow for updating...