GBusNameVanishedCallback: document NULL connection
authorRyan Lortie <desrt@desrt.ca>
Tue, 16 Oct 2012 16:29:22 +0000 (12:29 -0400)
committerRyan Lortie <desrt@desrt.ca>
Tue, 16 Oct 2012 16:40:21 +0000 (12:40 -0400)
@connection can be NULL for this callback.  Document this possibility
and describe the circumstances.

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

gio/gdbusnamewatching.h

index 3e3f75a..a2bb6dc 100644 (file)
@@ -49,12 +49,17 @@ typedef void (*GBusNameAppearedCallback) (GDBusConnection *connection,
 
 /**
  * GBusNameVanishedCallback:
- * @connection: The #GDBusConnection the name is being watched on.
+ * @connection: The #GDBusConnection the name is being watched on, or
+ *     %NULL.
  * @name: The name being watched.
  * @user_data: User data passed to g_bus_watch_name().
  *
  * Invoked when the name being watched is known not to have to have a owner.
  *
+ * This is also invoked when the #GDBusConection on which the watch was
+ * established has been closed.  In that case, @connection will be
+ * %NULL.
+ *
  * Since: 2.26
  */
 typedef void (*GBusNameVanishedCallback) (GDBusConnection *connection,