Add DBUS_ERROR_INITIALIZER macro

diff --git a/dbus/dbus-errors.c b/dbus/dbus-errors.c
index d0a80b02a35d5f85cd12aa350548c58726ac4f2c..30bf6a1fbf1fc5f98ff455448080f10439720ab4 100644 (file)
--- 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
  */

diff --git a/dbus/dbus-errors.h b/dbus/dbus-errors.h
index e01818c46c38a616abb619653beb6beabc7eec47..ee1700713a0a6aa2d8f8be2270de390fb0c1497a 100644 (file)
--- a/dbus/dbus-errors.h
+++ b/dbus/dbus-errors.h
@@ -58,6 +58,8 @@ struct DBusError
   void *padding1; /**< placeholder */
 };
 
+#define DBUS_ERROR_INITIALIZER { NULL, NULL, 0, 0, 0, 0, 0, NULL }
+
 void        dbus_error_init      (DBusError       *error);
 void        dbus_error_free      (DBusError       *error);
 void        dbus_set_error       (DBusError       *error,