From e78ad709e7680dca47b193463d0c6d7ac8b0f894 Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Sun, 24 Apr 2016 22:42:32 -0400 Subject: [PATCH] doc: Move request:: handler to their own documentation section --- docs/config.ld | 2 ++ lib/awful/ewmh.lua | 7 ++++++- lib/awful/mouse/init.lua | 2 +- 3 files changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/config.ld b/docs/config.ld index 8ff7c13e0..19886170c 100644 --- a/docs/config.ld +++ b/docs/config.ld @@ -35,6 +35,8 @@ new_type("function", "Functions") 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 diff --git a/lib/awful/ewmh.lua b/lib/awful/ewmh.lua index f63ef5055..d110cd314 100644 --- a/lib/awful/ewmh.lua +++ b/lib/awful/ewmh.lua @@ -101,6 +101,7 @@ end -- -- It is the default signal handler for `request::activate` on a `client`. -- +-- @signalhandler awful.ewmh.activate -- @client c A client to use -- @tparam string context The context where this signal was used. -- @tparam[opt] table hints A table with additional hints: @@ -121,8 +122,11 @@ function ewmh.activate(c, context, hints) -- luacheck: no unused args end end ---- Tag a window with its requested tag +--- Tag a window with its requested tag. -- +-- It is the default signal handler for `request::tag` on a `client`. +-- +-- @signalhandler awful.ewmh.tag -- @client c A client to tag -- @tag[opt] t A tag to use. If omitted, then the client is made sticky. -- @tparam[opt={}] table hints Extra information @@ -157,6 +161,7 @@ local context_mapper = { -- -- This is the default geometry request handler. -- +-- @signalhandler awful.ewmh.geometry -- @tparam client c The client -- @tparam string context The context -- @tparam[opt={}] table hints The hints to pass to the handler diff --git a/lib/awful/mouse/init.lua b/lib/awful/mouse/init.lua index 67468d74c..14c405481 100644 --- a/lib/awful/mouse/init.lua +++ b/lib/awful/mouse/init.lua @@ -236,7 +236,7 @@ function mouse.client.resize(c, corner, args) end --- Default handler for `request::geometry` signals with `mouse.resize` context. --- @function awful.mouse.resize_handler +-- @signalhandler awful.mouse.resize_handler -- @tparam client c The client -- @tparam string context The context -- @tparam[opt={}] table hints The hints to pass to the handler