summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--dbus/dbus-glib.h2
-rw-r--r--dbus/dbus-gvalue.c44
-rw-r--r--doc/reference/dbus-glib-sections.txt4
3 files changed, 45 insertions, 5 deletions
diff --git a/dbus/dbus-glib.h b/dbus/dbus-glib.h
index 014230c..09659c7 100644
--- a/dbus/dbus-glib.h
+++ b/dbus/dbus-glib.h
@@ -192,9 +192,11 @@ GObject * dbus_g_connection_lookup_g_object (DBusGConnection *connectio
#define DBUS_TYPE_G_STRING_STRING_HASHTABLE (dbus_g_type_get_map ("GHashTable", G_TYPE_STRING, G_TYPE_STRING))
+typedef gchar DBusGObjectPath;
GType dbus_g_object_path_get_g_type (void) G_GNUC_CONST;
#define DBUS_TYPE_G_OBJECT_PATH (dbus_g_object_path_get_g_type ())
+typedef gchar DBusGSignature;
GType dbus_g_signature_get_g_type (void) G_GNUC_CONST;
#define DBUS_TYPE_G_SIGNATURE (dbus_g_signature_get_g_type ())
diff --git a/dbus/dbus-gvalue.c b/dbus/dbus-gvalue.c
index a76e059..af47d6d 100644
--- a/dbus/dbus-gvalue.c
+++ b/dbus/dbus-gvalue.c
@@ -357,9 +357,27 @@ _dbus_g_value_types_init (void)
}
/**
- * Get the GLib type ID for a DBusGObjectPath boxed type.
+ * DBusGObjectPath:
*
- * Returns: GLib type
+ * A typedef for a string used to represent D-Bus object paths.
+ * Its GType is %DBUS_TYPE_G_OBJECT_PATH, derived from %G_TYPE_BOXED.
+ *
+ * Prior to version 0.FIXME this was used as the type name of
+ * %DBUS_TYPE_G_OBJECT_PATH, but did not actually exist as a typedef.
+ *
+ * Since: 0.FIXME
+ */
+
+/**
+ * DBUS_TYPE_G_OBJECT_PATH:
+ *
+ * The #GType of a #DBusGObjectPath, which is a boxed type containing a
+ * D-Bus object path as a zero-terminated string. Object paths can be
+ * copied with g_strdup() and freed with g_free(), just like %G_TYPE_STRING,
+ * but have a distinct boxed type to allow them to be distinguished when
+ * stored in a #GValue.
+ *
+ * Returns: a type derived from %G_TYPE_BOXED
*/
GType
dbus_g_object_path_get_g_type (void)
@@ -374,9 +392,27 @@ dbus_g_object_path_get_g_type (void)
}
/**
- * Get the GLib type ID for a DBusGSignature boxed type.
+ * DBusGSignature:
+ *
+ * A typedef for a string used to represent D-Bus signatures.
+ * Its GType is %DBUS_TYPE_G_SIGNATURE, derived from %G_TYPE_BOXED.
+ *
+ * Prior to version 0.FIXME this was used as the type name of
+ * %DBUS_TYPE_G_SIGNATURE, but did not actually exist as a typedef.
+ *
+ * Since: 0.FIXME
+ */
+
+/**
+ * DBUS_TYPE_G_SIGNATURE:
+ *
+ * The #GType of a #DBusGSignature, which is a boxed type containing a
+ * D-Bus signature as a zero-terminated string. Signatures can be
+ * copied with g_strdup() and freed with g_free(), just like %G_TYPE_STRING,
+ * but have a distinct boxed type to allow them to be distinguished when
+ * stored in a #GValue.
*
- * Returns: GLib type
+ * Returns: a type derived from %G_TYPE_BOXED
*/
GType
dbus_g_signature_get_g_type (void)
diff --git a/doc/reference/dbus-glib-sections.txt b/doc/reference/dbus-glib-sections.txt
index e5d86d5..e2744b6 100644
--- a/doc/reference/dbus-glib-sections.txt
+++ b/doc/reference/dbus-glib-sections.txt
@@ -19,7 +19,6 @@ dbus_g_connection_get_g_type
<SECTION>
<FILE>dbus-gobject</FILE>
-DBUS_TYPE_G_OBJECT_PATH
<TITLE>DBus GObject related functions</TITLE>
DBusGObjectInfo
dbus_g_object_type_install_info
@@ -174,7 +173,10 @@ DBUS_TYPE_G_UINT64_ARRAY
DBUS_TYPE_G_INT64_ARRAY
DBUS_TYPE_G_OBJECT_ARRAY
DBUS_TYPE_G_STRING_STRING_HASHTABLE
+DBusGSignature
DBUS_TYPE_G_SIGNATURE
+DBusGObjectPath
+DBUS_TYPE_G_OBJECT_PATH
</SECTION>
<SUBSECTION Private>