2003-09-07 Havoc Pennington <hp@pobox.com>

	* Make Doxygen contented.

7 files changed, 50 insertions, 18 deletions

diff --git a/glib/dbus-gidl.c b/glib/dbus-gidl.c
index 12468abb..b867d178 100644
--- a/glib/dbus-gidl.c
+++ b/glib/dbus-gidl.c
@@ -24,6 +24,8 @@
 
 #include "dbus-gidl.h"
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+
 struct NodeInfo
 {
   int refcount;
@@ -402,3 +404,5 @@ _dbus_gidl_test (void)
 }
 
 #endif /* DBUS_BUILD_TESTS */
+
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
diff --git a/glib/dbus-gidl.h b/glib/dbus-gidl.h
index 6e4e207a..7a667240 100644
--- a/glib/dbus-gidl.h
+++ b/glib/dbus-gidl.h
@@ -24,6 +24,8 @@
 #ifndef DBUS_GLIB_IDL_H
 #define DBUS_GLIB_IDL_H
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+
 #include <dbus/dbus.h>
 #include <glib.h>
 
@@ -90,3 +92,5 @@ ArgDirection   arg_info_get_direction     (ArgInfo       *info);
 G_END_DECLS
 
 #endif /* DBUS_GLIB_IDL_H */
+
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
diff --git a/glib/dbus-glib.h b/glib/dbus-glib.h
index 3a87dec2..4015dd99 100644
--- a/glib/dbus-glib.h
+++ b/glib/dbus-glib.h
@@ -39,19 +39,28 @@ void dbus_server_setup_with_g_main     (DBusServer     *server,
 typedef struct DBusGObjectInfo DBusGObjectInfo;
 typedef struct DBusGMethodInfo DBusGMethodInfo;
 
+/**
+ * Object typically generated by dbus-glib-tool that
+ * stores a mapping from introspection data to a
+ * function pointer for a C method to be invoked.
+ */
 struct DBusGMethodInfo
 {
-  GCallback                 function;
-  DBusHandleMessageFunction marshaller;
-  int                       data_offset;
+  GCallback                 function;    /**< C method to invoke */
+  DBusHandleMessageFunction marshaller;  /**< Marshaller to go DBusMessage to C method */
+  int                       data_offset; /**< Offset into the introspection data */
 };
 
+/**
+ * Introspection data for a GObject, normally autogenerated by
+ * a tool such as dbus-glib-tool.
+ */
 struct DBusGObjectInfo
 {
-  const DBusGMethodInfo *infos;
-  const unsigned char *data;    
-  void *dbus_internal_padding1;
-  void *dbus_internal_padding2;
+  const DBusGMethodInfo *infos; /**< Array of method pointers */
+  const unsigned char *data;    /**< Introspection data */
+  void *dbus_internal_padding1; /**< Reserved for expansion */
+  void *dbus_internal_padding2; /**< Reserved for expansion */
 };
 
 void dbus_gobject_class_install_info  (GObjectClass          *object_class,
diff --git a/glib/dbus-gloader-expat.c b/glib/dbus-gloader-expat.c
index 050d3532..149e7117 100644
--- a/glib/dbus-gloader-expat.c
+++ b/glib/dbus-gloader-expat.c
@@ -43,13 +43,16 @@ static XML_Memory_Handling_Suite memsuite =
   g_free
 };
 
+/**
+ * Context for Expat parser for introspection data.
+ */
 typedef struct
 {
-  Parser *parser;
-  const char *filename;
-  GString *content;
-  GError **error;
-  gboolean failed;
+  Parser *parser;       /**< The parser for the introspection data */
+  const char *filename; /**< The filename being loaded */
+  GString *content;     /**< The content of the current element */
+  GError **error;       /**< Error return location */
+  gboolean failed;      /**< True if parse has failed */
 } ExpatParseContext;
 
 static dbus_bool_t
diff --git a/glib/dbus-gmain.c b/glib/dbus-gmain.c
index 36c6c6b4..c33f47e8 100644
--- a/glib/dbus-gmain.c
+++ b/glib/dbus-gmain.c
@@ -49,6 +49,9 @@
  */
 typedef struct DBusGSource DBusGSource;
 
+/**
+ * A GSource subclass for a DBusConnection.
+ */
 struct DBusGSource
 {
   GSource source; /**< the parent GSource */
diff --git a/glib/dbus-gparser.c b/glib/dbus-gparser.c
index c2b54d31..f7264b5e 100644
--- a/glib/dbus-gparser.c
+++ b/glib/dbus-gparser.c
@@ -28,6 +28,8 @@
 #define _(x) gettext ((x))
 #define N_(x) x
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+
 #define ELEMENT_IS(name) (strcmp (element_name, (name)) == 0)
 
 typedef struct
@@ -656,3 +658,5 @@ parser_get_nodes (Parser *parser)
 {
   return parser->result;
 }
+
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
diff --git a/glib/dbus-gproxy.c b/glib/dbus-gproxy.c
index 01a6b4b9..8951707b 100644
--- a/glib/dbus-gproxy.c
+++ b/glib/dbus-gproxy.c
@@ -28,17 +28,22 @@
  * @{
  */
 
+/**
+ * Internals of DBusGProxy
+ */
 struct DBusGProxy
 {
-  GStaticMutex lock;
-  int refcount;
-  DBusConnection *connection;
-  char *service;
-  char *interface;
-  char *path;
+  GStaticMutex lock; /**< Thread lock */
+  int refcount;      /**< Reference count */
+  DBusConnection *connection; /**< Connection to communicate over */
+  char *service;             /**< Service messages go to or NULL */
+  char *interface;           /**< Interface messages go to or NULL */
+  char *path;                /**< Path messages go to or NULL */
 };
 
+/** Lock the DBusGProxy */
 #define LOCK_PROXY(proxy)   (g_static_mutex_lock (&(proxy)->lock))
+/** Unlock the DBusGProxy */
 #define UNLOCK_PROXY(proxy) (g_static_mutex_unlock (&(proxy)->lock))
 
 static DBusGProxy*