luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-21 08:28:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Minor reformatting / gi-docgenification of signals docs

Browse Source 
This is nowhere near a complete check-through and gi-docgenification of
the signals docs, just a few bits I was looking at anyway.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>
Helps: #3250
This commit is contained in:
Philip Withnall
2024-03-06 13:23:48 +00:00
parent 8a640f50ca
commit fafe1a14a8
2 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/gobject/signals.md
View File

@@ -52,12 +52,12 @@ A signal emission consists of five stages, unless prematurely stopped:
1. Invocation of the object method handler for `G_SIGNAL_RUN_FIRST` signals 1. Invocation of the object method handler for `G_SIGNAL_RUN_FIRST` signals
2. Invocation of normal user-provided signal handlers (where the @after 2. Invocation of normal user-provided signal handlers (where the `after`
flag is not set) flag is not set)
3. Invocation of the object method handler for `G_SIGNAL_RUN_LAST` signals 3. Invocation of the object method handler for `G_SIGNAL_RUN_LAST` signals
4. Invocation of user provided signal handlers (where the @after flag is set) 4. Invocation of user provided signal handlers (where the `after` flag is set)
5. Invocation of the object method handler for `G_SIGNAL_RUN_CLEANUP` signals 5. Invocation of the object method handler for `G_SIGNAL_RUN_CLEANUP` signals
@@ -83,7 +83,7 @@ detail part of the signal specification upon connection) serves as a
wildcard and matches any detail argument passed in to emission. wildcard and matches any detail argument passed in to emission.
While the `detail` argument is typically used to pass an object property name While the `detail` argument is typically used to pass an object property name
(as with `GObject::notify`), no specific format is mandated for the detail (as with [signal@GObject.Object::notify]), no specific format is mandated for the detail
string, other than that it must be non-empty. string, other than that it must be non-empty.
## Memory management of signal handlers ## Memory management of signal handlers

7
gobject/gsignal.h
View File

@@ -500,11 +500,12 @@ void g_signal_chain_from_overridden_handler (gpointer instance,
* @c_handler: the #GCallback to connect. * @c_handler: the #GCallback to connect.
* @data: data to pass to @c_handler calls. * @data: data to pass to @c_handler calls.
* *
* Connects a #GCallback function to a signal for a particular object. * Connects a [type@GObject.Callback] function to a signal for a particular object.
* *
* The handler will be called synchronously, before the default handler of the signal. g_signal_emit() will not return control until all handlers are called. * The handler will be called synchronously, before the default handler of the signal.
* [func@GObject.signal_emit] will not return control until all handlers are called.
* *
* See [memory management of signal handlers][signals.html#Memory_management_of_signal_handlers] for * See [memory management of signal handlers](signals.html#Memory_management_of_signal_handlers) for
* details on how to handle the return value and memory management of @data. * details on how to handle the return value and memory management of @data.
* *
* Returns: the handler ID, of type #gulong (always greater than 0 for successful connections) * Returns: the handler ID, of type #gulong (always greater than 0 for successful connections)