ldoc

ldoc copied to clipboard

function with inline return and errors won't work

1

 In the screenshot above we can see that the doc generated by LDoc 1.4.6 to the right only has the `name` param....

ziras

Functions with long names and many parameters break function table

9

Functions with long names and many parameters break function tables. Since I just added a few new functions with even longer names and even more parameters, it got pretty bad...

ghost

Function which behave depending on parameter type: How to document ?

2

Following example ```lua ------------------------------------------------------------ -- get element from object -- @param[type=number] tag index of object 1...n -- @param[type=string] tag name of object to get -- @return obj,idx (obj,number) object and...

jjvbsag

Hello, I saw that @static is listed in the source code (https://github.com/stevedonovan/LDoc/blob/master/ldoc/doc.lua#L30) and works great for defining static functions (vs class methods) in the output of ldoc but I notice...

scazan

Cannot use multiple @raise on a single Function

3

If you set multiple `@raise` such as ```lua --- Some Function -- @return something -- @raise error 1 that can be thrown -- @raise error 2 that can be thrown...

ktalebian

When you have a `@script foo` and a `@module foo`, on either pages both entries in the side bar will not be linked, not just the one you're currently viewing.

DarkWiiPlayer

Is there a way to have ldoc generate name tags and a small button to copy the link to that page to that name (Like github does in the readme)...

nico-abram

Ldoc and Lua disagrees concerning tables

1

Hi, I got this error message from Ldoc related to a table that I defined. > DEFAULT_TIME_OF_DAY: declared table cannot have array entries Now, Lua itself seems is fine with...

FredrikKarlssonSpeech

a file in "/Themes/__fallback/Scripts/03 Utility.lua" has the following name in the generated docs: , and one in "/Themes/Til Death/Scripts" is just "til". Any help is apprecciated, LDoc seems awesome!

nico-abram

Add example for `config.ld` to LDoc's documentation

1

LDoc's documentation is pretty decent overall. However, there is one problem: at no point do you show or explain what a `config.ld` file looks like. Perhaps this was a concept...

NicolBolas