awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add inheritance tags to `docs/common/object.ldoc`.

This commit is contained in:
Aire-One 2019-11-26 13:49:42 +01:00 committed by Emmanuel Lepage Vallee
parent bc35da73ac
commit 550e346d7b
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/common/object.ldoc
View File

@ -3,6 +3,7 @@
-- @tparam string name The name of the signal. -- @tparam string name The name of the signal.
-- @tparam function func The callback that should be disconnected. -- @tparam function func The callback that should be disconnected.
-- @method disconnect_signal -- @method disconnect_signal
-- @baseclass gears.object
--- Emit a signal. --- Emit a signal.
-- --
@ -11,11 +12,13 @@
-- function receives the object as first argument and then any extra -- function receives the object as first argument and then any extra
-- arguments that are given to emit_signal(). -- arguments that are given to emit_signal().
-- @method emit_signal -- @method emit_signal
-- @baseclass gears.object
--- Connect to a signal. --- Connect to a signal.
-- @tparam string name The name of the signal. -- @tparam string name The name of the signal.
-- @tparam function func The callback to call when the signal is emitted. -- @tparam function func The callback to call when the signal is emitted.
-- @method connect_signal -- @method connect_signal
-- @baseclass gears.object
--- Connect to a signal weakly. --- Connect to a signal weakly.
-- --
@ -28,3 +31,4 @@
-- @tparam string name The name of the signal. -- @tparam string name The name of the signal.
-- @tparam function func The callback to call when the signal is emitted. -- @tparam function func The callback to call when the signal is emitted.
-- @method weak_connect_signal -- @method weak_connect_signal
-- @baseclass gears.object