Repository navigation
Expand file tree
/
Copy pathconfig.ld
More file actions
74 lines (64 loc) · 1.9 KB
/
Copy pathconfig.ld
File metadata and controls
74 lines (64 loc) · 1.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
-- Configuration file for ldoc
project='awesome'
title='awesome API documentation'
description='API documentation for awesome, a highly configurable X window manager (version @AWESOME_VERSION@).'
-- More on it: https://github.com/stevedonovan/LDoc/blob/master/doc/doc.md#markdown-support
format='discount'
dir='../doc'
-- Make the docs prettier
pretty='lua'
style="!pale"
backtick_references=true
merge=true
use_markdown_titles=true
wrap=true
topics={
'00-authors.md',
'01-readme.md',
'02-contributing.md',
}
-- Setup @client to be an alias for "@tparam client.object"
tparam_alias('client', 'client.object')
tparam_alias('tag', 'tag')
-- Should be default, but is not. Sets up "@tab" => "@tparam table".
tparam_alias('tab', 'table')
-- New type for signals
new_type("signal", "Signals", false, "Arguments")
-- More fitting section names
kind_names={topic='Documentation', module='Libraries'}
-- Sort modules alphabetically
sort_modules=true
file = {
-- C parts of libraries
'../dbus.c',
'../keygrabber.c',
'../luaa.c',
'../mouse.c',
'../mousegrabber.c',
'../root.c',
'../selection.c',
'../spawn.c',
'../xkb.c',
'../common/luaobject.c',
'../objects/',
-- LUA libraries
'../lib/',
exclude = {
-- exclude these modules, as they do not contain any written
-- documentation
'../lib/awful/autofocus.lua',
'../lib/awful/dbus.lua',
'../lib/awful/init.lua',
'../lib/awful/remote.lua',
'../lib/awful/startup_notification.lua',
'../lib/gears/init.lua',
'../lib/wibox/layout/init.lua',
'../lib/wibox/widget/init.lua',
'../lib/wibox/widget/systray.lua',
-- Ignore some parts of the widget library
'../lib/awful/widget/init.lua',
-- exclude layout, but we need an extra bit of documentation elsewhere.
'../lib/awful/layout/suit/'
}
}
-- vim: filetype=lua