From 29feceb80d8f920ace2d02d3b5d0dc8cd954f92d Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Thu, 31 Mar 2016 02:36:44 -0400 Subject: [PATCH] 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. --- docs/aliases/awful_client.lua | 6 ++++++ docs/config.ld | 2 ++ lib/awful/client.lua | 2 +- 3 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/aliases/awful_client.lua diff --git a/docs/aliases/awful_client.lua b/docs/aliases/awful_client.lua new file mode 100644 index 000000000..b8cd3b804 --- /dev/null +++ b/docs/aliases/awful_client.lua @@ -0,0 +1,6 @@ +--------------------------------------------------------------------------- +--- This module is deprecated, use `client` +-- =============================== +-- +-- @module awful.client +--------------------------------------------------------------------------- diff --git a/docs/config.ld b/docs/config.ld index d3f093354..958ede527 100644 --- a/docs/config.ld +++ b/docs/config.ld @@ -63,6 +63,8 @@ file = { '../objects/', -- LUA libraries '../lib/', + -- Old APIs the user should not longer use directly + '../../docs/aliases/awful_client.lua', exclude = { -- exclude these modules, as they do not contain any written -- documentation diff --git a/lib/awful/client.lua b/lib/awful/client.lua index cb5aa8afb..0b754ccc2 100644 --- a/lib/awful/client.lua +++ b/lib/awful/client.lua @@ -4,7 +4,7 @@ -- @author Julien Danjou <julien@danjou.info> -- @copyright 2008 Julien Danjou -- @release @AWESOME_VERSION@ --- @module awful.client +-- @module client --------------------------------------------------------------------------- -- Grab environment we need