gobject-2.0: Annotate GSignal functions taking instances
authorEmmanuele Bassi <ebassi@gnome.org>
Tue, 27 Aug 2013 12:11:47 +0000 (14:11 +0200)
committerMartin Pitt <martinpitt@gnome.org>
Mon, 2 Sep 2013 06:25:56 +0000 (08:25 +0200)
Unbreak the GSignal API at least for GObject sub-classes.

https://bugzilla.gnome.org/show_bug.cgi?id=685387

gobject/gsignal.c

index 951b9c0..903557e 100644 (file)
@@ -864,7 +864,7 @@ _g_signals_destroy (GType itype)
 
 /**
  * g_signal_stop_emission:
- * @instance: the object whose signal handlers you wish to stop.
+ * @instance: (type GObject.Object): the object whose signal handlers you wish to stop.
  * @signal_id: the signal identifier, as returned by g_signal_lookup().
  * @detail: the detail which the signal was emitted with.
  *
@@ -1128,7 +1128,7 @@ g_signal_parse_name (const gchar *detailed_signal,
 
 /**
  * g_signal_stop_emission_by_name:
- * @instance: the object whose signal handlers you wish to stop.
+ * @instance: (type GObject.Object): the object whose signal handlers you wish to stop.
  * @detailed_signal: a string of the form "signal-name::detail".
  *
  * Stops a signal's current emission.
@@ -2069,7 +2069,7 @@ g_signal_chain_from_overridden (const GValue *instance_and_params,
 }
 
 /**
- * g_signal_chain_from_overridden_handler:
+ * g_signal_chain_from_overridden_handler: (skip)
  * @instance: the instance the signal is being emitted on.
  * @...: parameters to be passed to the parent class closure, followed by a
  *  location for the return value. If the return type of the signal
@@ -2233,7 +2233,7 @@ g_signal_chain_from_overridden_handler (gpointer instance,
 
 /**
  * g_signal_get_invocation_hint:
- * @instance: the instance to query
+ * @instance: (type GObject.Object): the instance to query
  *
  * Returns the invocation hint of the innermost signal emission of instance.
  *
@@ -2255,7 +2255,7 @@ g_signal_get_invocation_hint (gpointer instance)
 
 /**
  * g_signal_connect_closure_by_id:
- * @instance: the instance to connect to.
+ * @instance: (type GObject.Object): the instance to connect to.
  * @signal_id: the id of the signal.
  * @detail: the detail.
  * @closure: the closure to connect.
@@ -2315,7 +2315,7 @@ g_signal_connect_closure_by_id (gpointer  instance,
 
 /**
  * g_signal_connect_closure:
- * @instance: the instance to connect to.
+ * @instance: (type GObject.Object): the instance to connect to.
  * @detailed_signal: a string of the form "signal-name::detail".
  * @closure: the closure to connect.
  * @after: whether the handler should be called before or after the
@@ -2403,7 +2403,7 @@ node_check_deprecated (const SignalNode *node)
 
 /**
  * g_signal_connect_data:
- * @instance: the instance to connect to.
+ * @instance: (type GObject.Object): the instance to connect to.
  * @detailed_signal: a string of the form "signal-name::detail".
  * @c_handler: the #GCallback to connect.
  * @data: data to pass to @c_handler calls.
@@ -2480,7 +2480,7 @@ g_signal_connect_data (gpointer       instance,
 
 /**
  * g_signal_handler_block:
- * @instance: The instance to block the signal handler of.
+ * @instance: (type GObject.Object): The instance to block the signal handler of.
  * @handler_id: Handler id of the handler to be blocked.
  *
  * Blocks a handler of an instance so it will not be called during any
@@ -2518,7 +2518,7 @@ g_signal_handler_block (gpointer instance,
 
 /**
  * g_signal_handler_unblock:
- * @instance: The instance to unblock the signal handler of.
+ * @instance: (type GObject.Object): The instance to unblock the signal handler of.
  * @handler_id: Handler id of the handler to be unblocked.
  *
  * Undoes the effect of a previous g_signal_handler_block() call.  A
@@ -2560,7 +2560,7 @@ g_signal_handler_unblock (gpointer instance,
 
 /**
  * g_signal_handler_disconnect:
- * @instance: The instance to remove the signal handler from.
+ * @instance: (type GObject.Object): The instance to remove the signal handler from.
  * @handler_id: Handler id of the handler to be disconnected.
  *
  * Disconnects a handler from an instance so it will not be called during
@@ -2596,7 +2596,7 @@ g_signal_handler_disconnect (gpointer instance,
 
 /**
  * g_signal_handler_is_connected:
- * @instance: The instance where a signal handler is sought.
+ * @instance: (type GObject.Object): The instance where a signal handler is sought.
  * @handler_id: the handler id.
  *
  * Returns whether @handler_id is the id of a handler connected to @instance.
@@ -2665,7 +2665,7 @@ g_signal_handlers_destroy (gpointer instance)
 
 /**
  * g_signal_handler_find:
- * @instance: The instance owning the signal handler to be found.
+ * @instance: (type GObject.Object): The instance owning the signal handler to be found.
  * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
  *  and/or @data the handler has to match.
  * @signal_id: Signal the handler has to be connected to.
@@ -2745,7 +2745,7 @@ signal_handlers_foreach_matched_R (gpointer         instance,
 
 /**
  * g_signal_handlers_block_matched:
- * @instance: The instance to block handlers from.
+ * @instance: (type GObject.Object): The instance to block handlers from.
  * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
  *  and/or @data the handlers have to match.
  * @signal_id: Signal the handlers have to be connected to.
@@ -2792,7 +2792,7 @@ g_signal_handlers_block_matched (gpointer         instance,
 
 /**
  * g_signal_handlers_unblock_matched:
- * @instance: The instance to unblock handlers from.
+ * @instance: (type GObject.Object): The instance to unblock handlers from.
  * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
  *  and/or @data the handlers have to match.
  * @signal_id: Signal the handlers have to be connected to.
@@ -2840,7 +2840,7 @@ g_signal_handlers_unblock_matched (gpointer         instance,
 
 /**
  * g_signal_handlers_disconnect_matched:
- * @instance: The instance to remove handlers from.
+ * @instance: (type GObject.Object): The instance to remove handlers from.
  * @mask: Mask indicating which of @signal_id, @detail, @closure, @func
  *  and/or @data the handlers have to match.
  * @signal_id: Signal the handlers have to be connected to.
@@ -2888,7 +2888,7 @@ g_signal_handlers_disconnect_matched (gpointer         instance,
 
 /**
  * g_signal_has_handler_pending:
- * @instance: the object whose signal handlers are sought.
+ * @instance: (type GObject.Object): the object whose signal handlers are sought.
  * @signal_id: the signal id.
  * @detail: the detail.
  * @may_be_blocked: whether blocked handlers should count as match.
@@ -3077,7 +3077,7 @@ accumulate (GSignalInvocationHint *ihint,
 }
 
 /**
- * g_signal_emit_valist:
+ * g_signal_emit_valist: (skip)
  * @instance: the instance the signal is being emitted on.
  * @signal_id: the signal id
  * @detail: the detail
@@ -3358,7 +3358,7 @@ g_signal_emit_valist (gpointer instance,
 
 /**
  * g_signal_emit:
- * @instance: the instance the signal is being emitted on.
+ * @instance: (type GObject.Object): the instance the signal is being emitted on.
  * @signal_id: the signal id
  * @detail: the detail
  * @...: parameters to be passed to the signal, followed by a
@@ -3385,7 +3385,7 @@ g_signal_emit (gpointer instance,
 
 /**
  * g_signal_emit_by_name:
- * @instance: the instance the signal is being emitted on.
+ * @instance: (type GObject.Object): the instance the signal is being emitted on.
  * @detailed_signal: a string of the form "signal-name::detail".
  * @...: parameters to be passed to the signal, followed by a
  *  location for the return value. If the return type of the signal