summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon McVittie <simon.mcvittie@collabora.co.uk>2011-05-31 16:17:34 +0100
committerSimon McVittie <simon.mcvittie@collabora.co.uk>2011-09-27 15:30:23 +0100
commit35e049459945a22b87cc61c05bd903790f05cf40 (patch)
treecc94b7666ce7d854908ede9463bd8ef3d4e91e38
parent43a4bf8b038c08d6b8c565495cbf69433bc2dcc6 (diff)
Add DBUS_TYPE_CONNECTION, DBUS_TYPE_MESSAGE to the docs, and document them better
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Cosimo Alfarano <cosimo.alfarano@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=37793 Bug-NB: related to NB#218973
-rw-r--r--dbus/dbus-glib.c15
-rw-r--r--doc/reference/dbus-glib-sections.txt2
2 files changed, 12 insertions, 5 deletions
diff --git a/dbus/dbus-glib.c b/dbus/dbus-glib.c
index 3b32beb..f64903a 100644
--- a/dbus/dbus-glib.c
+++ b/dbus/dbus-glib.c
@@ -219,8 +219,11 @@ dbus_g_error_get_name (GError *error)
}
/**
- * dbus_connection_get_g_type:
- * Get the GLib type ID for a #DBusConnection boxed type.
+ * DBUS_TYPE_CONNECTION:
+ *
+ * Expands to a function call returning a boxed #GType representing a
+ * #DBusConnection pointer from libdbus. Not to be confused with
+ * %DBUS_TYPE_G_CONNECTION, which you should usually use instead.
*
* Returns: the GLib type
*/
@@ -238,8 +241,12 @@ dbus_connection_get_g_type (void)
}
/**
- * dbus_message_get_g_type:
- * Get the GLib type ID for a #DBusMessage boxed type.
+ * DBUS_TYPE_MESSAGE:
+ *
+ * Expands to a function call returning a boxed #GType representing a
+ * #DBusMessage pointer from libdbus. Not to be confused with
+ * %DBUS_TYPE_G_MESSAGE, which you should usually use instead.
+ *
*
* Returns: the GLib type
*/
diff --git a/doc/reference/dbus-glib-sections.txt b/doc/reference/dbus-glib-sections.txt
index 8aa31b4..d2434ed 100644
--- a/doc/reference/dbus-glib-sections.txt
+++ b/doc/reference/dbus-glib-sections.txt
@@ -114,9 +114,9 @@ dbus_set_g_error
dbus_connection_setup_with_g_main
dbus_connection_get_g_connection
dbus_server_setup_with_g_main
-<SUBSECTION Standard>
DBUS_TYPE_CONNECTION
DBUS_TYPE_MESSAGE
+<SUBSECTION Standard>
DBUS_TYPE_PENDING_CALL
dbus_connection_get_g_type
dbus_message_get_g_type