diff options
author | Havoc Pennington <hp@redhat.com> | 2002-11-23 07:05:53 +0000 |
---|---|---|
committer | Havoc Pennington <hp@redhat.com> | 2002-11-23 07:05:53 +0000 |
commit | 55de3878c42f8254bac653b7c1998e79a1658ae2 (patch) | |
tree | 4b82a4f6cab2d11a9dbef77def9b16875899b55d | |
parent | 1428c65e7c46fd9f52e43b7424c56552ec2686e8 (diff) |
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
-rw-r--r-- | ChangeLog | 10 | ||||
-rw-r--r-- | dbus/dbus-hash.c | 7 | ||||
-rw-r--r-- | dbus/dbus-hash.h | 4 | ||||
-rw-r--r-- | dbus/dbus-memory.h | 4 | ||||
-rw-r--r-- | dbus/dbus-message.c | 33 | ||||
-rw-r--r-- | dbus/dbus-message.h | 4 |
6 files changed, 46 insertions, 16 deletions
@@ -1,5 +1,15 @@ 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 diff --git a/dbus/dbus-hash.c b/dbus/dbus-hash.c index 15272510..419a7848 100644 --- 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 cc6fb19d..267b2e94 100644 --- 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 b8caa832..7e4d522b 100644 --- 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 0266ba4e..fdc0c342 100644 --- 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 8c69d06f..d86f5d23 100644 --- 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 */ |