mirror of
https://github.com/awesomeWM/awesome
synced 2024-11-17 07:47:41 +01:00
119 lines
3.8 KiB
Text
119 lines
3.8 KiB
Text
-- 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
|
|
full_description = [[
|
|
Welcome to the documentation for the awesome window manager. Below you find an
|
|
overview of the individual parts which links to the full documentation.
|
|
|
|
If you are a new user, you may want to read @{07-my-first-awesome.md} to get
|
|
started. In @{05-awesomerc.md}, the default configuration is explained.
|
|
|
|
If you already used awesome in the past, @{89-NEWS.md} and @{17-porting-tips.md}
|
|
should be useful for you.
|
|
]]
|
|
topics={
|
|
'00-authors.md',
|
|
'01-readme.md',
|
|
'02-contributing.md',
|
|
'03-declarative-layout.md',
|
|
'04-new-widgets.md',
|
|
'05-awesomerc.md',
|
|
'06-appearance.md',
|
|
'07-my-first-awesome.md',
|
|
'16-using-cairo.md',
|
|
'17-porting-tips.md',
|
|
'90-FAQ.md',
|
|
'89-NEWS.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')
|
|
tparam_alias('screen', 'screen')
|
|
tparam_alias('screen_or_idx', 'screen|int')
|
|
|
|
-- Hack to get the functions and method on top of the signals and properties
|
|
new_type("function", "Functions")
|
|
-- Documentation for objects properties
|
|
new_type("property", "Object properties", false, "Type")
|
|
-- New type for signals
|
|
new_type("signal", "Signals", false, "Arguments")
|
|
-- New type for signals connections
|
|
new_type("signalhandler", "Request handlers", false, "Arguments")
|
|
-- Allow objects to define a set of beautiful properties affecting them
|
|
new_type("beautiful", "Theme variables", false, "Type")
|
|
-- Put deprecated methods in their own section
|
|
new_type("deprecated", "Deprecated functions", false, "param")
|
|
-- For the legacy stateless layout related functions
|
|
new_type("legacylayout", "Layout related functions", false, "param")
|
|
-- Have a category for the client layouts
|
|
new_type("clientlayout", "Client layouts", false, "param")
|
|
-- Document some callback prototypes
|
|
new_type("callback", "Callback functions prototype", false, "Parameters")
|
|
|
|
-- More fitting section names
|
|
kind_names={topic='Documentation', module='Libraries', script='Sample files'}
|
|
|
|
-- 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/',
|
|
-- Auto generated scripts
|
|
'../script_files/',
|
|
-- Old APIs the user should not longer use directly
|
|
'../docs/aliases/awful_client.lua',
|
|
'../docs/aliases/awful_screen.lua',
|
|
'../docs/aliases/awful_tag.lua',
|
|
'../docs/aliases/awful_mouse.lua',
|
|
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/container/init.lua',
|
|
|
|
-- Ignore some parts of the widget library
|
|
'../lib/awful/widget/init.lua',
|
|
|
|
-- Ignore the drawing window, users should only care about wiboxes
|
|
'../objects/drawin.c',
|
|
}
|
|
}
|
|
|
|
-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
|