From 85ab0327d82e4945ad16630e583d8cc68df25a90 Mon Sep 17 00:00:00 2001
From: Havoc Pennington <hp@redhat.com>
Date: Sun, 7 Sep 2003 23:04:54 +0000
Subject: 2003-09-07  Havoc Pennington  <hp@pobox.com>

	* Make Doxygen contented.
---
 dbus/dbus-errors.c | 84 +++++++++++++++++++++++++++++++-----------------------
 1 file changed, 48 insertions(+), 36 deletions(-)

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

diff --git a/dbus/dbus-errors.c b/dbus/dbus-errors.c
index 82e48025..f7b2f740 100644
--- a/dbus/dbus-errors.c
+++ b/dbus/dbus-errors.c
@@ -28,48 +28,21 @@
 #include <string.h>
 
 /**
- * @defgroup DBusErrors Error reporting
- * @ingroup  DBus
- * @brief Error reporting
- *
- * Types and functions related to reporting errors.
- *
- *
- * In essence D-BUS error reporting works as follows:
- *
- * @code
- * DBusError error;
- * dbus_error_init (&error);
- * dbus_some_function (arg1, arg2, &error);
- * if (dbus_error_is_set (&error))
- *   {
- *     fprintf (stderr, "an error occurred: %s\n", error.message);
- *     dbus_error_free (&error);
- *   }
- * @endcode
- *
- * There are some rules. An error passed to a D-BUS function must
- * always be unset; you can't pass in an error that's already set.  If
- * a function has a return code indicating whether an error occurred,
- * and also a #DBusError parameter, then the error will always be set
- * if and only if the return code indicates an error occurred. i.e.
- * the return code and the error are never going to disagree.
- *
- * An error only needs to be freed if it's been set, not if
- * it's merely been initialized.
- *
- * You can check the specific error that occurred using
- * dbus_error_has_name().
- * 
+ * @defgroup DBusErrorInternals Error reporting internals
+ * @ingroup  DBusInternals
+ * @brief Error reporting internals
  * @{
  */
-
+ 
+/**
+ * Internals of DBusError
+ */
 typedef struct
 {
   const char *name; /**< error name */
   char *message; /**< error message */
 
-  unsigned int const_message : 1; /** Message is not owned by DBusError */
+  unsigned int const_message : 1; /**< Message is not owned by DBusError */
 
   unsigned int dummy2 : 1; /**< placeholder */
   unsigned int dummy3 : 1; /**< placeholder */
@@ -127,6 +100,45 @@ message_from_error (const char *error)
     return error;
 }
 
+/** @} */ /* End of internals */
+
+/**
+ * @defgroup DBusErrors Error reporting
+ * @ingroup  DBus
+ * @brief Error reporting
+ *
+ * Types and functions related to reporting errors.
+ *
+ *
+ * In essence D-BUS error reporting works as follows:
+ *
+ * @code
+ * DBusError error;
+ * dbus_error_init (&error);
+ * dbus_some_function (arg1, arg2, &error);
+ * if (dbus_error_is_set (&error))
+ *   {
+ *     fprintf (stderr, "an error occurred: %s\n", error.message);
+ *     dbus_error_free (&error);
+ *   }
+ * @endcode
+ *
+ * There are some rules. An error passed to a D-BUS function must
+ * always be unset; you can't pass in an error that's already set.  If
+ * a function has a return code indicating whether an error occurred,
+ * and also a #DBusError parameter, then the error will always be set
+ * if and only if the return code indicates an error occurred. i.e.
+ * the return code and the error are never going to disagree.
+ *
+ * An error only needs to be freed if it's been set, not if
+ * it's merely been initialized.
+ *
+ * You can check the specific error that occurred using
+ * dbus_error_has_name().
+ * 
+ * @{
+ */
+
 /**
  * Initializes a DBusError structure. Does not allocate
  * any memory; the error only needs to be freed
@@ -358,4 +370,4 @@ dbus_set_error (DBusError  *error,
   dbus_set_error_const (error, DBUS_ERROR_NO_MEMORY, NULL);      
 }
 
-/** @} */
+/** @} */ /* End public API */
-- 
cgit