2003-02-13 Anders Carlsson <andersca@codefactory.se>

	* dbus/dbus-errors.c:
	* dbus/dbus-message.c:
	* dbus/dbus-string.c:
	Documentation fixes.

diff --git a/ChangeLog b/ChangeLog
index 5c5645c..3d7d23f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
 2003-02-13  Anders Carlsson  <andersca@codefactory.se>
 
+       * dbus/dbus-errors.c:
+       * dbus/dbus-message.c:
+       * dbus/dbus-string.c:
+       Documentation fixes.
+
+2003-02-13  Anders Carlsson  <andersca@codefactory.se>
+
        * glib/dbus-gmain.c: (timeout_handler), (add_timeout),
        (remove_timeout):
        Implement support for timeouts in dbus-glib.

diff --git a/dbus/dbus-errors.c b/dbus/dbus-errors.c
index 50c26d3..86bdc03 100644 (file)
--- 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,

diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c
index b4d391c..dbdd141 100644 (file)
--- a/dbus/dbus-message.c
+++ b/dbus/dbus-message.c
@@ -780,7 +780,6 @@ dbus_message_new (const char *service,
  * message. Returns #NULL if memory can't be allocated
  * for the message.
  *
- * @param name the name of the message
  * @param original_message the message which the created
  * message is a reply to.
  * @returns a new DBusMessage, free with dbus_message_unref()

diff --git a/dbus/dbus-string.c b/dbus/dbus-string.c
index daa4297..9c2f727 100644 (file)
--- a/dbus/dbus-string.c
+++ b/dbus/dbus-string.c
@@ -1556,6 +1556,7 @@ _dbus_string_equal (const DBusString *a,
  *
  * @param a first string
  * @param b second string
+ * @param len the lengh
  * @returns #TRUE if equal for the given number of bytes
  */
 dbus_bool_t