summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-errors.c
diff options
context:
space:
mode:
Diffstat (limited to 'dbus/dbus-errors.c')
-rw-r--r--dbus/dbus-errors.c24
1 files changed, 23 insertions, 1 deletions
diff --git a/dbus/dbus-errors.c b/dbus/dbus-errors.c
index d0a80b02..30bf6a1f 100644
--- a/dbus/dbus-errors.c
+++ b/dbus/dbus-errors.c
@@ -34,7 +34,29 @@
* @brief Error reporting internals
* @{
*/
-
+
+/**
+ * @def DBUS_ERROR_INITIALIZER
+ *
+ * Expands to a suitable initializer for a DBusError on the stack.
+ * Declaring a DBusError with:
+ *
+ * @code
+ * DBusError error = DBUS_ERROR_INITIALIZER;
+ *
+ * do_things_with (&error);
+ * @endcode
+ *
+ * is a more concise form of:
+ *
+ * @code
+ * DBusError error;
+ *
+ * dbus_error_init (&error);
+ * do_things_with (&error);
+ * @endcode
+ */
+
/**
* Internals of DBusError
*/