summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-errors.c
diff options
context:
space:
mode:
authorAnders Carlsson <andersca@codefactory.se>2003-02-13 20:56:44 +0000
committerAnders Carlsson <andersca@codefactory.se>2003-02-13 20:56:44 +0000
commita7c05492537b149f67760ecb1958350900843173 (patch)
treef09829ccb71902fe7e812b1cdba5fa1fe4514889 /dbus/dbus-errors.c
parentfef27dc10d03bf0b80e11e77739e50322aa163b9 (diff)
2003-02-13 Anders Carlsson <andersca@codefactory.se>
* dbus/dbus-errors.c: * dbus/dbus-message.c: * dbus/dbus-string.c: Documentation fixes.
Diffstat (limited to 'dbus/dbus-errors.c')
-rw-r--r--dbus/dbus-errors.c27
1 files changed, 27 insertions, 0 deletions
diff --git a/dbus/dbus-errors.c b/dbus/dbus-errors.c
index 50c26d39..86bdc037 100644
--- a/dbus/dbus-errors.c
+++ b/dbus/dbus-errors.c
@@ -124,6 +124,11 @@ dbus_result_to_string (DBusResultCode code)
return "Invalid error code";
}
+/**
+ * Initializes a DBusError structure.
+ *
+ * @param error the DBusError.
+ */
void
dbus_error_init (DBusError *error)
{
@@ -141,6 +146,11 @@ dbus_error_init (DBusError *error)
real->const_message = TRUE;
}
+/**
+ * Frees an error created by dbus_error_init().
+ *
+ * @param error memory where the error is stored.
+ */
void
dbus_error_free (DBusError *error)
{
@@ -152,6 +162,14 @@ dbus_error_free (DBusError *error)
dbus_free (real->message);
}
+/**
+ * Assigns an error name and message to a DBusError.
+ * Does nothing if error is #NULL.
+ *
+ * @param error the error.
+ * @param name the error name (not copied!!!)
+ * @param message the error message (not copied!!!)
+ */
void
dbus_set_error_const (DBusError *error,
const char *name,
@@ -171,6 +189,15 @@ dbus_set_error_const (DBusError *error,
real->const_message = TRUE;
}
+/**
+ * Assigns an error name and message to a DBusError.
+ * Does nothing if error is #NULL.
+ *
+ * @param error the error.
+ * @param name the error name (not copied!!!)
+ * @param format printf-style format string.
+ * @returns #TRUE on success.
+ */
dbus_bool_t
dbus_set_error (DBusError *error,
const char *name,