From 15ef0ef6fbba7827453b7973e62b6c1853576601 Mon Sep 17 00:00:00 2001
From: Havoc Pennington <hp@redhat.com>
Date: Fri, 20 Oct 2006 03:05:00 +0000
Subject: 2006-10-19  Havoc Pennington  <hp@redhat.com>

	* Fix a pile of Doxygen warnings and missing docs
---
 dbus/dbus-shared.h | 28 ++++++++++++++++++++++++----
 1 file changed, 24 insertions(+), 4 deletions(-)

(limited to 'dbus/dbus-shared.h')

diff --git a/dbus/dbus-shared.h b/dbus/dbus-shared.h
index 357327da..78d305ef 100644
--- a/dbus/dbus-shared.h
+++ b/dbus/dbus-shared.h
@@ -30,6 +30,9 @@
 
 #ifdef  __cplusplus
 extern "C" {
+#if 0
+} /* avoids confusing emacs indentation */
+#endif
 #endif
 
 /* Normally docs are in .c files, but there isn't a .c file for this. */
@@ -44,6 +47,9 @@ extern "C" {
  */
 
 
+/**
+ * Well-known bus types. See dbus_bus_get().
+ */
 typedef enum
 {
   DBUS_BUS_SESSION,    /**< The login session bus */
@@ -51,26 +57,37 @@ typedef enum
   DBUS_BUS_STARTER     /**< The bus that started us, if any */
 } DBusBusType;
 
+/**
+ * Results that a message handler can return.
+ */
 typedef enum
 {
-  DBUS_HANDLER_RESULT_HANDLED,         /**< Message has had its effect */ 
-  DBUS_HANDLER_RESULT_NOT_YET_HANDLED, /**< Message has not had any effect */
-  DBUS_HANDLER_RESULT_NEED_MEMORY      /**< Need more memory to return another result */
+  DBUS_HANDLER_RESULT_HANDLED,         /**< Message has had its effect - no need to run more handlers. */ 
+  DBUS_HANDLER_RESULT_NOT_YET_HANDLED, /**< Message has not had any effect - see if other handlers want it. */
+  DBUS_HANDLER_RESULT_NEED_MEMORY      /**< Need more memory in order to return #DBUS_HANDLER_RESULT_HANDLED or #DBUS_HANDLER_RESULT_NOT_YET_HANDLED. Please try again later with more memory. */
 } DBusHandlerResult;
 
-/* Services */
+/* Bus names */
+
+/** The bus name used to talk to the bus itself. */
 #define DBUS_SERVICE_DBUS      "org.freedesktop.DBus"
 
 /* Paths */
+/** The object path used to talk to the bus itself. */
 #define DBUS_PATH_DBUS  "/org/freedesktop/DBus"
+/** The object path used in local/in-process-generated messages. */
 #define DBUS_PATH_LOCAL "/org/freedesktop/DBus/Local"
 
 /* Interfaces, these #define don't do much other than
  * catch typos at compile time
  */
+/** The interface exported by the object with #DBUS_SERVICE_DBUS and #DBUS_PATH_DBUS */
 #define DBUS_INTERFACE_DBUS           "org.freedesktop.DBus"
+/** The interface supported by introspectable objects */
 #define DBUS_INTERFACE_INTROSPECTABLE "org.freedesktop.DBus.Introspectable"
+/** The interface supported by objects with properties */
 #define DBUS_INTERFACE_PROPERTIES     "org.freedesktop.DBus.Properties"
+/** The interface supported by most dbus peers */
 #define DBUS_INTERFACE_PEER           "org.freedesktop.DBus.Peer"
 
 /** This is a special interface whose methods can only be invoked
@@ -102,6 +119,9 @@ typedef enum
 /** @} */
 
 #ifdef __cplusplus
+#if 0
+{ /* avoids confusing emacs indentation */
+#endif
 }
 #endif
 
-- 
cgit