From 63b19efef8011eb67968c726255630acefc6ccc0 Mon Sep 17 00:00:00 2001 From: Daniel Hahler Date: Tue, 7 Jul 2015 17:19:41 +0200 Subject: [PATCH] doc: signals: minor improvements, mainly for "tagged" --- objects/client.c | 10 ++++++---- objects/tag.c | 6 ++++-- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/objects/client.c b/objects/client.c index 06bd1ad30..2c3c067ed 100644 --- a/objects/client.c +++ b/objects/client.c @@ -2640,7 +2640,7 @@ client_class_setup(lua_State *L) (lua_class_propfunc_t) luaA_client_get_client_shape_clip, NULL); - /** when a client gains focus + /** When a client gains focus. * @signal .focus */ signal_add(&client_class.signals, "focus"); @@ -2868,11 +2868,12 @@ client_class_setup(lua_State *L) * @signal request::urgent */ signal_add(&client_class.signals, "request::urgent"); - /** when client is tagged + /** When a client gets tagged. * @signal .tagged + * @tag t The tag object. */ signal_add(&client_class.signals, "tagged"); - /** when a client looses focus + /** When a client gets unfocused. * @signal .unfocus */ signal_add(&client_class.signals, "unfocus"); @@ -2880,8 +2881,9 @@ client_class_setup(lua_State *L) * @signal .unmanage */ signal_add(&client_class.signals, "unmanage"); - /** when client looses tag + /** When a client gets untagged. * @signal .untagged + * @tag t The tag object. */ signal_add(&client_class.signals, "untagged"); } diff --git a/objects/tag.c b/objects/tag.c index b694079ab..152f14d36 100644 --- a/objects/tag.c +++ b/objects/tag.c @@ -395,12 +395,14 @@ tag_class_setup(lua_State *L) * @signal request::select */ signal_add(&tag_class.signals, "request::select"); - /** + /** When a client gets tagged with this tag. * @signal tagged + * @client c The tagged client. */ signal_add(&tag_class.signals, "tagged"); - /** + /** When a client gets untagged with this tag. * @signal untagged + * @client c The untagged client. */ signal_add(&tag_class.signals, "untagged"); }