lunarmodules/ldoc

document nested tables?

FatalistError opened this issue · 2 comments

FatalistError commented

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

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

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?