Commit Graph

3 Commits

Author SHA1 Message Date
Ignas Anikevicius (gns_ank) 400ba86ead Docs: Use LDoc markdown support, exclude files.
Use markdown support, which is bundled together with LDoc.

Also, add a macro for the client type, which will simplify parameter
definitions. With this we can write `@client` instead of `@tparam
client` in order to denote that the parameter needs to be a client
structure. This simplifies `awful.client` module.

This also excludes some of the `.lua` files from generating the
documentation, because some of the files do not contain useful
information or any public functions at all. This make the docs easier to
navigate.

Remove layouts from documentation

Signed-off-by: Ignas Anikevicius (gns_ank) <anikevicius@gmail.com>
2015-02-28 23:14:11 +01:00
Daniel Hahler 289bc26a3c doc: config.ld: setup @client alias, and use it
It also adds the "@tab" alias, which did not work for me, but should be
the default?!
2015-02-15 22:33:23 +01:00
Uli Schlachter c87e775e46 Use LDoc instead of Luadoc (FS#1006)
Since we are no longer using module(), luadoc no longer understands our modules.
With this commit we use LDoc instead which seems more modern.

Signed-off-by: Uli Schlachter <psychon@znc.in>
2012-11-19 14:57:47 +01:00