search

lunarmodules / ldoc

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-printed example files.
https://lunarmodules.github.io/ldoc/
Other
789 stars 173 forks source link

document nested tables? #406

Open FatalistError opened 7 months ago

FatalistError commented 7 months ago

Hi, I have a class which has a number of nested tables example:

class = {
    properties = {
        prop1 = 0,
        table1 = {
            subprop1 = "something",
            subprop2 = 1,
        }
    }
}

I have absolutely no idea how to document this without expanding the file massively. It doesn't seem to be possible. I can document the first level but beyond that it won't let me using non-explicit comments, and I would have to define explicit tags elsewhere in the file for each subtable. This table structure is incredibly large, has many sub-tables. How can I document it while still having the documentation for it be clear and not make my file 10000 lines long?

Elv13 commented 7 months ago

You can if you mess around with the LTP HTML template and enable it, but you cannot by default. You can see some of those abuses in our doc https://awesomewm.org/apidoc/core_components/client.html

FatalistError commented 7 months ago

You can if you mess around with the LTP HTML template and enable it, but you cannot by default. You can see some of those abuses in our doc https://awesomewm.org/apidoc/core_components/client.html

haha I have literally no idea what you're talking about... but i'll uh... look... into it?