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>
This commit is contained in:
Ignas Anikevicius (gns_ank) 2014-05-19 10:48:23 +01:00 committed by Daniel Hahler
parent 20ca989333
commit 400ba86ead
1 changed files with 30 additions and 3 deletions

View File

@ -2,12 +2,39 @@
project='awesome' project='awesome'
title='awesome API documentation' title='awesome API documentation'
description='highly configurable X window manager' description='highly configurable X window manager'
--format='markdown' or should it be discount? what is that anyway? how about plain?
-- More on it: https://github.com/stevedonovan/LDoc/blob/master/doc/doc.md#markdown-support
format='markdown'
dir='doc' dir='doc'
file={ 'lib/', '@SOURCE_DIR@/luadoc' }
-- Make the docs prettier
pretty='lua'
backtick_references=true
merge=true
readme='README.md'
-- Setup @client to be an alias for "@tparam client.client" -- Setup @client to be an alias for "@tparam client.client"
tparam_alias('client', 'client.client') tparam_alias('client', 'client.client')
tparam_alias('tag', 'tag')
-- Should be default, but is not. Sets up "@tab" => "@tparam table". -- Should be default, but is not. Sets up "@tab" => "@tparam table".
tparam_alias('tab', 'table') tparam_alias('tab', 'table')
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