summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2011-04-01 13:44:23 -0400
committerMatthias Clasen <mclasen@redhat.com>2011-04-01 13:44:23 -0400
commit471498c62119ccd8ad34a6a2d49b3935e470f255 (patch)
tree2e6b72fed83a683256f6ac7d80cc8b3a6136e677
parent770442f2de192de81f35215351e1bfc72f4b206b (diff)
Docs: explain what a NULL vtable might be good for2.28.5
https://bugzilla.gnome.org/show_bug.cgi?id=646419
-rw-r--r--gio/gdbusconnection.c21
1 files changed, 13 insertions, 8 deletions
diff --git a/gio/gdbusconnection.c b/gio/gdbusconnection.c
index 44d5446df..b8ba677df 100644
--- a/gio/gdbusconnection.c
+++ b/gio/gdbusconnection.c
@@ -4624,13 +4624,13 @@ obj_message_func (GDBusConnection *connection,
/**
* g_dbus_connection_register_object:
- * @connection: A #GDBusConnection.
- * @object_path: The object path to register at.
- * @interface_info: Introspection data for the interface.
- * @vtable: A #GDBusInterfaceVTable to call into or %NULL.
- * @user_data: Data to pass to functions in @vtable.
- * @user_data_free_func: Function to call when the object path is unregistered.
- * @error: Return location for error or %NULL.
+ * @connection: A #GDBusConnection
+ * @object_path: The object path to register at
+ * @interface_info: Introspection data for the interface
+ * @vtable: A #GDBusInterfaceVTable to call into, or %NULL
+ * @user_data: Data to pass to functions in @vtable
+ * @user_data_free_func: Function to call when the object path is unregistered
+ * @error: Return location for error or %NULL
*
* Registers callbacks for exported objects at @object_path with the
* D-Bus interface that is described in @interface_info.
@@ -4669,7 +4669,12 @@ obj_message_func (GDBusConnection *connection,
* reference count is -1, see g_dbus_interface_info_ref()) for as long
* as the object is exported. Also note that @vtable will be copied.
*
- * See <xref linkend="gdbus-server"/> for an example of how to use this method.
+ * A %NULL @vtable can be used for
+ * <ulink url="http://en.wikipedia.org/wiki/Marker_interface_pattern">marker
+ * interfaces</ulink>.
+ *
+ * See <xref linkend="gdbus-server"/> for an example of how to use this
+ * method.
*
* Returns: 0 if @error is set, otherwise a registration id (never 0)
* that can be used with g_dbus_connection_unregister_object() .