From 262c02a9facebc8592fa60406d8971b1837725f5 Mon Sep 17 00:00:00 2001
From: Simon McVittie <simon.mcvittie@collabora.co.uk>
Date: Tue, 9 Oct 2007 17:34:09 +0100
Subject: Add DBUS_ERROR_INITIALIZER macro

---
 dbus/dbus-errors.c | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

(limited to 'dbus/dbus-errors.c')

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
  */
-- 
cgit