Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document nested tables? #406

Open
FatalistError opened this issue Mar 28, 2024 · 2 comments
Open

document nested tables? #406

FatalistError opened this issue Mar 28, 2024 · 2 comments

Comments

@FatalistError
Copy link

FatalistError commented Mar 28, 2024

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
Copy link

Elv13 commented Mar 29, 2024

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
Copy link
Author

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants