From c21511c01ab56d75f3aa4643761e9fd096a7f8be Mon Sep 17 00:00:00 2001 From: Havoc Pennington Date: Wed, 19 Feb 2003 03:53:24 +0000 Subject: 2003-02-19 Havoc Pennington Throughout: mop up all the Doxygen warnings and undocumented stuff. * dbus/dbus-sysdeps.c (do_exec): do not use execvp, we don't want to search any paths. * dbus/dbus-threads.c: move global mutex initializers to dbus-internals.h, multiple prototypes was confusing doxygen besides being kind of ugly * Doxyfile (PREDEFINED): have Doxygen define DOXYGEN_SHOULD_SKIP_THIS so we can exclude things from docs with #ifndef DOXYGEN_SHOULD_SKIP_THIS (do not abuse the feature! it's for stuff like the autogenerated macros in dbus-md5.c, not just for things you don't feel like documenting...) --- dbus/dbus-connection.c | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) (limited to 'dbus/dbus-connection.c') diff --git a/dbus/dbus-connection.c b/dbus/dbus-connection.c index 64aa5863..7da89bdc 100644 --- a/dbus/dbus-connection.c +++ b/dbus/dbus-connection.c @@ -82,21 +82,19 @@ struct DBusConnection { int refcount; /**< Reference count. */ - DBusMutex *mutex; + DBusMutex *mutex; /**< Lock on the entire DBusConnection */ - /* Protects dispatch_message */ - dbus_bool_t dispatch_acquired; - DBusCondVar *dispatch_cond; - - /* Protects transport io path */ - dbus_bool_t io_path_acquired; - DBusCondVar *io_path_cond; + dbus_bool_t dispatch_acquired; /**< Protects dispatch_message */ + DBusCondVar *dispatch_cond; /**< Protects dispatch_message */ + + dbus_bool_t io_path_acquired; /**< Protects transport io path */ + DBusCondVar *io_path_cond; /**< Protects transport io path */ DBusList *outgoing_messages; /**< Queue of messages we need to send, send the end of the list first. */ DBusList *incoming_messages; /**< Queue of messages we have received, end of the list received most recently. */ DBusMessage *message_borrowed; /**< True if the first incoming message has been borrowed */ - DBusCondVar *message_returned_cond; + DBusCondVar *message_returned_cond; /**< Used with dbus_connection_borrow_message() */ int n_outgoing; /**< Length of outgoing queue. */ int n_incoming; /**< Length of incoming queue. */ @@ -114,7 +112,7 @@ struct DBusConnection DBusCounter *connection_counter; /**< Counter that we decrement when finalized */ int client_serial; /**< Client serial. Increments each time a message is sent */ - DBusList *disconnect_message_link; + DBusList *disconnect_message_link; /**< Preallocated list node for queueing the disconnection message */ }; typedef struct @@ -1955,7 +1953,12 @@ static int n_allocated_slots = 0; static int n_used_slots = 0; static DBusMutex *allocated_slots_lock = NULL; -DBusMutex *_dbus_allocated_slots_init_lock (void); +/** + * Initialize the mutex used for #DBusConnecton data + * slot reservations. + * + * @returns the mutex + */ DBusMutex * _dbus_allocated_slots_init_lock (void) { -- cgit