Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
awesome/config.ld.in

41 lines
1.0 KiB
Plaintext
Raw Normal View History

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
-- Configuration file for ldoc
project='awesome'
title='awesome API documentation'
description='highly configurable X window manager'
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>
2014-05-19 11:48:23 +02:00
-- More on it: https://github.com/stevedonovan/LDoc/blob/master/doc/doc.md#markdown-support
format='markdown'
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
dir='doc'
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>
2014-05-19 11:48:23 +02:00
-- Make the docs prettier
pretty='lua'
backtick_references=true
merge=true
readme='README.md'
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
-- Setup @client to be an alias for "@tparam client.client"
tparam_alias('client', 'client.client')
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>
2014-05-19 11:48:23 +02:00
tparam_alias('tag', 'tag')
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
-- Should be default, but is not. Sets up "@tab" => "@tparam table".
tparam_alias('tab', 'table')
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>
2014-05-19 11:48:23 +02:00
file = {
'lib/',
'luadoc/',
readme,
exclude = {
-- exclude these modules, as they do not contain any written
-- documentation
'lib/awful/autofocus.lua',
'lib/awful/dbus.lua',
'lib/awful/ewmh.lua',
'lib/awful/remote.lua',
'lib/awful/startup_notification.lua',
-- exclude layout, but we need an extra bit of documentation elsewhere.
'lib/awful/layout/suit/'
}
}
-- vim: filetype=lua