mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-11-03 09:01:42 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

utils: Reference some useful methods in wl_signal's doxygen

Browse source 
This commit adds a bit more detail on the lifecycle of a signal.
This commit is contained in:
Aaron Faanes 2013-09-15 13:37:06 -05:00 • committed by Kristian Høgsberg
parent f8b2730039
commit bc30c5eb8a
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
src/wayland-server.h
View file

@ -185,7 +185,12 @@ struct wl_listener {
* *
* Signals are recognized points where significant events can be observed. * Signals are recognized points where significant events can be observed.
* Compositors as well as the server can provide signals. Observers are * Compositors as well as the server can provide signals. Observers are
* added through \ref wl_signal_add. * wl_listener's that are added through #wl_signal_add. Signals are emitted
* using #wl_signal_emit, which will invoke all listeners until that
* listener is removed by #wl_list_remove (or whenever the signal is
* destroyed).
*
* \sa wl_listener for more information on using wl_signal
*/ */
struct wl_signal { struct wl_signal {
struct wl_list listener_list; struct wl_list listener_list;