mirror of
https://github.com/awesomeWM/awesome
synced 2024-11-17 07:47:41 +01:00
documentation: Merge awful.client and client pages
ldoc doesn't allow to specify fields from class "A" into class "B", so the only solution is to merge the 2. Also, one of the most common complain on IRC since Awesome 3.0 is that the client API doc is confusing since it is in 2 different files. Also restore the `awful.client` doc link, point to `client` This will avoid broken links.
This commit is contained in:
parent
82342f055c
commit
29feceb80d
3 changed files with 9 additions and 1 deletions
6
docs/aliases/awful_client.lua
Normal file
6
docs/aliases/awful_client.lua
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
---------------------------------------------------------------------------
|
||||||
|
--- This module is deprecated, use `client`
|
||||||
|
-- ===============================
|
||||||
|
--
|
||||||
|
-- @module awful.client
|
||||||
|
---------------------------------------------------------------------------
|
|
@ -63,6 +63,8 @@ file = {
|
||||||
'../objects/',
|
'../objects/',
|
||||||
-- LUA libraries
|
-- LUA libraries
|
||||||
'../lib/',
|
'../lib/',
|
||||||
|
-- Old APIs the user should not longer use directly
|
||||||
|
'../../docs/aliases/awful_client.lua',
|
||||||
exclude = {
|
exclude = {
|
||||||
-- exclude these modules, as they do not contain any written
|
-- exclude these modules, as they do not contain any written
|
||||||
-- documentation
|
-- documentation
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
-- @author Julien Danjou <julien@danjou.info>
|
-- @author Julien Danjou <julien@danjou.info>
|
||||||
-- @copyright 2008 Julien Danjou
|
-- @copyright 2008 Julien Danjou
|
||||||
-- @release @AWESOME_VERSION@
|
-- @release @AWESOME_VERSION@
|
||||||
-- @module awful.client
|
-- @module client
|
||||||
---------------------------------------------------------------------------
|
---------------------------------------------------------------------------
|
||||||
|
|
||||||
-- Grab environment we need
|
-- Grab environment we need
|
||||||
|
|
Loading…
Reference in a new issue