luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-03 09:46:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

gsignal: Tidy up signal naming documentation

Browse Source 
Since signal names are the same as property names, reference between the
two. Improve the formatting, and make it clearer that `_` is
discouraged.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Helps: #358
This commit is contained in:
Philip Withnall 2019-11-12 19:35:19 +00:00
parent 26970edc9f
commit b8eb6025f1
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
gobject/gsignal.c
View File

@ -1403,12 +1403,14 @@ g_signal_query (guint signal_id,
* Creates a new signal. (This is usually done in the class initializer.) * Creates a new signal. (This is usually done in the class initializer.)
* *
* A signal name consists of segments consisting of ASCII letters and * A signal name consists of segments consisting of ASCII letters and
* digits, separated by either the '-' or '_' character. The first * digits, separated by either the `-` or `_` character. The first
* character of a signal name must be a letter. Names which violate these * character of a signal name must be a letter. Names which violate these
* rules lead to undefined behaviour of the GSignal system. * rules lead to undefined behaviour. These are the same rules as for property
* naming (see g_param_spec_internal()).
* *
* When registering a signal and looking up a signal, either separator can * When registering a signal and looking up a signal, either separator can
* be used, but they cannot be mixed. * be used, but they cannot be mixed. Using `-` is considerably more efficient.
* Using `_` is discouraged.
* *
* If 0 is used for @class_offset subclasses cannot override the class handler * If 0 is used for @class_offset subclasses cannot override the class handler
* in their class_init method by doing super_class->signal_handler = my_signal_handler. * in their class_init method by doing super_class->signal_handler = my_signal_handler.