Merge pull request #295 from blueyed/doc-signals

doc: signals: minor improvements, mainly for "tagged"
This commit is contained in:
Emmanuel Lepage Vallée 2015-07-07 16:09:22 -04:00
commit a09fee243c
2 changed files with 10 additions and 6 deletions

View File

@ -2640,7 +2640,7 @@ client_class_setup(lua_State *L)
(lua_class_propfunc_t) luaA_client_get_client_shape_clip, (lua_class_propfunc_t) luaA_client_get_client_shape_clip,
NULL); NULL);
/** when a client gains focus /** When a client gains focus.
* @signal .focus * @signal .focus
*/ */
signal_add(&client_class.signals, "focus"); signal_add(&client_class.signals, "focus");
@ -2868,11 +2868,12 @@ client_class_setup(lua_State *L)
* @signal request::urgent * @signal request::urgent
*/ */
signal_add(&client_class.signals, "request::urgent"); signal_add(&client_class.signals, "request::urgent");
/** when client is tagged /** When a client gets tagged.
* @signal .tagged * @signal .tagged
* @tag t The tag object.
*/ */
signal_add(&client_class.signals, "tagged"); signal_add(&client_class.signals, "tagged");
/** when a client looses focus /** When a client gets unfocused.
* @signal .unfocus * @signal .unfocus
*/ */
signal_add(&client_class.signals, "unfocus"); signal_add(&client_class.signals, "unfocus");
@ -2880,8 +2881,9 @@ client_class_setup(lua_State *L)
* @signal .unmanage * @signal .unmanage
*/ */
signal_add(&client_class.signals, "unmanage"); signal_add(&client_class.signals, "unmanage");
/** when client looses tag /** When a client gets untagged.
* @signal .untagged * @signal .untagged
* @tag t The tag object.
*/ */
signal_add(&client_class.signals, "untagged"); signal_add(&client_class.signals, "untagged");
} }

View File

@ -395,12 +395,14 @@ tag_class_setup(lua_State *L)
* @signal request::select * @signal request::select
*/ */
signal_add(&tag_class.signals, "request::select"); signal_add(&tag_class.signals, "request::select");
/** /** When a client gets tagged with this tag.
* @signal tagged * @signal tagged
* @client c The tagged client.
*/ */
signal_add(&tag_class.signals, "tagged"); signal_add(&tag_class.signals, "tagged");
/** /** When a client gets untagged with this tag.
* @signal untagged * @signal untagged
* @client c The untagged client.
*/ */
signal_add(&tag_class.signals, "untagged"); signal_add(&tag_class.signals, "untagged");
} }