diff options
Diffstat (limited to 'dbus/dbus-errors.c')
-rw-r--r-- | dbus/dbus-errors.c | 24 |
1 files changed, 23 insertions, 1 deletions
diff --git a/dbus/dbus-errors.c b/dbus/dbus-errors.c index d0a80b02..9629c682 100644 --- a/dbus/dbus-errors.c +++ b/dbus/dbus-errors.c @@ -34,7 +34,29 @@ * @brief Error reporting internals * @{ */ - + +/** + * @def DBUS_ERROR_INIT + * + * Expands to a suitable initializer for a DBusError on the stack. + * Declaring a DBusError with: + * + * @code + * DBusError error = DBUS_ERROR_INIT; + * + * 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 */ |