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
* Doxyfile.in (EXTRACT_STATIC): set to NO, so we don't have
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 */
static void free_entry (DBusHashTable *table,
DBusHashEntry *entry);
-/** }@ */
+/** @} */
/**
* @addtogroup DBusHashTable
return table->n_entries;
}
-/** }@ */
+/** @} */
#ifdef DBUS_BUILD_TESTS
#include "dbus-test.h"
#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.
void *value);
int _dbus_hash_table_get_n_entries (DBusHashTable *table);
-DBUS_END_DECLS
+DBUS_END_DECLS;
#endif /* DBUS_HASH_H */
#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);
typedef void (* DBusFreeFunction) (void *memory);
-DBUS_END_DECLS
+DBUS_END_DECLS;
#endif /* DBUS_MESSAGE_H */
#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()
#include <dbus/dbus-macros.h>
-DBUS_BEGIN_DECLS
+DBUS_BEGIN_DECLS;
typedef struct DBusMessage DBusMessage;
void dbus_message_unref (DBusMessage *message);
-DBUS_END_DECLS
+DBUS_END_DECLS;
#endif /* DBUS_MESSAGE_H */