2002-11-23 Havoc Pennington <hp@pobox.com>

	* dbus/dbus-message.h: put semicolons after DEBUG_BEGIN_DECLS
	to avoid confusing Doxygen

	* dbus/dbus-hash.c: @} not }@

	* dbus/dbus-message.c (struct DBusMessage): split out
	internals docs

diff --git a/ChangeLog b/ChangeLog
index 9ad95735407951f3a8b7c544ee8f531525f11cee..08535c68b2bcc4ec3f222602c315cdbeee3e101d 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2002-11-23  Havoc Pennington  <hp@pobox.com>
+
+       * dbus/dbus-message.h: put semicolons after DEBUG_BEGIN_DECLS 
+       to avoid confusing Doxygen
+
+       * dbus/dbus-hash.c: @} not }@
+
+       * dbus/dbus-message.c (struct DBusMessage): split out 
+       internals docs
+
 2002-11-23  Havoc Pennington  <hp@pobox.com>
 
        * configure.in: pile on more warning flags if using gcc

diff --git a/dbus/dbus-hash.c b/dbus/dbus-hash.c
index 15272510e00132ac49ed93a5cafd79776bd2e0df..419a7848382dbd93b263a768c9b5332cdce65405 100644 (file)
--- a/dbus/dbus-hash.c
+++ b/dbus/dbus-hash.c
@@ -145,7 +145,8 @@ typedef DBusHashEntry* (* DBusFindEntryFunction) (DBusHashTable   *table,
                                                   DBusHashEntry ***bucket);
 
 /**
- * Hash table internal members.
+ * Hash table internal members. Hash tables are opaque objects,
+ * they must be used via accessor functions.
  */
 struct DBusHashTable {
   int refcount;                       /**< Reference count */
@@ -216,7 +217,7 @@ static void           remove_entry         (DBusHashTable   *table,
 static void           free_entry           (DBusHashTable   *table,
                                             DBusHashEntry   *entry);
 
-/** }@ */
+/** @} */
 
 /**
  * @addtogroup DBusHashTable
@@ -1056,7 +1057,7 @@ _dbus_hash_table_get_n_entries (DBusHashTable *table)
   return table->n_entries;
 }
 
-/** }@ */
+/** @} */
 
 #ifdef DBUS_BUILD_TESTS
 #include "dbus-test.h"

diff --git a/dbus/dbus-hash.h b/dbus/dbus-hash.h
index cc6fb19d97e9610c2a63cee128a9771d6b58352c..267b2e94d9e9eafa897a2d2081d9f28f1c6aca90 100644 (file)
--- a/dbus/dbus-hash.h
+++ b/dbus/dbus-hash.h
@@ -27,7 +27,7 @@
 #include <dbus/dbus-memory.h>
 #include <dbus/dbus-types.h>
 
-DBUS_BEGIN_DECLS
+DBUS_BEGIN_DECLS;
 
 /* The iterator is on the stack, but its real fields are
  * hidden privately.
@@ -94,6 +94,6 @@ dbus_bool_t _dbus_hash_table_insert_int    (DBusHashTable *table,
                                             void          *value);
 int         _dbus_hash_table_get_n_entries (DBusHashTable *table);
 
-DBUS_END_DECLS
+DBUS_END_DECLS;
 
 #endif /* DBUS_HASH_H */

diff --git a/dbus/dbus-memory.h b/dbus/dbus-memory.h
index b8caa832a2b192652716ea0dd16143ab9ae9d1a6..7e4d522b62c46e47355787acb6bf101f1371fb2b 100644 (file)
--- a/dbus/dbus-memory.h
+++ b/dbus/dbus-memory.h
@@ -30,7 +30,7 @@
 #include <dbus/dbus-macros.h>
 #include <stddef.h>
 
-DBUS_BEGIN_DECLS
+DBUS_BEGIN_DECLS;
 
 void* dbus_malloc        (size_t bytes);
 void* dbus_malloc0       (size_t bytes);
@@ -43,6 +43,6 @@ void  dbus_free          (void  *memory);
 
 typedef void (* DBusFreeFunction) (void *memory);
 
-DBUS_END_DECLS
+DBUS_END_DECLS;
 
 #endif /* DBUS_MESSAGE_H */

diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c
index 0266ba4e719fe7acdfd32cb6831671bee3b215d1..fdc0c34229859af90238b60ec9adff6a02c64225 100644 (file)
--- a/dbus/dbus-message.c
+++ b/dbus/dbus-message.c
@@ -24,26 +24,45 @@
 #include "dbus-message.h"
 
 /**
- * @defgroup DBusMessage DBusMessage
- * @ingroup  DBus
- * @brief DBusMessage object
+ * @defgroup DBusMessageInternals DBusMessage implementation details
+ * @ingroup DBusInternals
+ * @brief DBusMessage private implementation details.
  *
- * Types and functions related to the DBusMessage object.
+ * The guts of DBusMessage and its methods.
  *
  * @{
  */
 
 /**
- * @struct DBusMessage
  * Object representing a message received from or to be sent to
- * another application.
+ * another application. This is an opaque object, all members
+ * are private.
  */
 struct DBusMessage
 {
   int refcount; /**< Reference count */
-
+  
 };
 
+/** @} */
+
+/**
+ * @defgroup DBusMessage DBusMessage
+ * @ingroup  DBus
+ * @brief DBusMessage object
+ *
+ * Types and functions related to the DBusMessage object.
+ *
+ * @{
+ */
+
+/**
+ * @typedef DBusMessage
+ *
+ * Opaque data type representing a message received from or to be
+ * sent to another application.
+ */
+
 /**
  * Constructs a new message.
  * @return a new DBusMessage, free with dbus_message_unref()

diff --git a/dbus/dbus-message.h b/dbus/dbus-message.h
index 8c69d06f5eb5e2ad65ebfe845a6439726ae693a7..d86f5d23cfe28c145a451210f9c5f431705c6234 100644 (file)
--- a/dbus/dbus-message.h
+++ b/dbus/dbus-message.h
@@ -29,7 +29,7 @@
 
 #include <dbus/dbus-macros.h>
 
-DBUS_BEGIN_DECLS
+DBUS_BEGIN_DECLS;
 
 typedef struct DBusMessage DBusMessage;
 
@@ -39,6 +39,6 @@ void         dbus_message_ref   (DBusMessage *message);
 void         dbus_message_unref (DBusMessage *message);
 
 
-DBUS_END_DECLS
+DBUS_END_DECLS;
 
 #endif /* DBUS_MESSAGE_H */