From cb81ac7edeb97f9f97ace8c990c5fdcb3c991345 Mon Sep 17 00:00:00 2001 From: Havoc Pennington Date: Sun, 31 Jul 2005 02:09:15 +0000 Subject: 2005-07-30 Havoc Pennington * fix a bunch of Doxygen warnings and mistakes --- ChangeLog | 4 ++++ dbus/dbus-message.c | 3 +++ dbus/dbus-signature.c | 8 +++++--- dbus/dbus-sysdeps.c | 1 + glib/dbus-glib.c | 4 ++-- glib/dbus-gobject.c | 2 +- glib/dbus-gproxy.c | 4 ++-- 7 files changed, 18 insertions(+), 8 deletions(-) diff --git a/ChangeLog b/ChangeLog index 9f693a21..c967ea43 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2005-07-30 Havoc Pennington + + * fix a bunch of Doxygen warnings and mistakes + 2005-07-30 Havoc Pennington * dbus/dbus-sysdeps.c (_dbus_string_parse_uint): remove #ifdef diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c index 880c25ef..0b5bc63e 100644 --- a/dbus/dbus-message.c +++ b/dbus/dbus-message.c @@ -2434,6 +2434,7 @@ dbus_message_get_path (DBusMessage *message) * Checks if the message has a path * * @param message the message + * @param path the path name * @returns #TRUE if there is a path field in the header */ dbus_bool_t @@ -2554,6 +2555,7 @@ dbus_message_get_interface (DBusMessage *message) * Checks if the message has an interface * * @param message the message + * @param interface the interface name * @returns #TRUE if there is a interface field in the header */ dbus_bool_t @@ -2634,6 +2636,7 @@ dbus_message_get_member (DBusMessage *message) * Checks if the message has an interface member * * @param message the message + * @param member the member name * @returns #TRUE if there is a member field in the header */ dbus_bool_t diff --git a/dbus/dbus-signature.c b/dbus/dbus-signature.c index 7118bd25..a66b7191 100644 --- a/dbus/dbus-signature.c +++ b/dbus/dbus-signature.c @@ -35,7 +35,9 @@ typedef struct } DBusSignatureRealIter; /** - * @addtogroup DBusSignature + * @defgroup DBusSignature Type signature parsing + * @ingroup DBus + * @brief Parsing D-BUS type signatures * @{ */ @@ -200,7 +202,7 @@ dbus_signature_iter_recurse (const DBusSignatureIter *iter, * Check a type signature for validity. * * @param signature a potentially invalid type signature - * @error error return + * @param error error return * @returns TRUE iif signature is valid */ dbus_bool_t @@ -222,7 +224,7 @@ dbus_signature_validate (const char *signature, * one complete type. * * @param signature a potentially invalid type signature - * @error error return + * @param error error return * @returns TRUE iif signature is valid and has exactly one complete type */ dbus_bool_t diff --git a/dbus/dbus-sysdeps.c b/dbus/dbus-sysdeps.c index 749059cb..b1404e43 100644 --- a/dbus/dbus-sysdeps.c +++ b/dbus/dbus-sysdeps.c @@ -1161,6 +1161,7 @@ _dbus_string_parse_int (const DBusString *str, * Checks to make sure the given directory is * private to the user * +* @param dir the name of the directory * @param error error return * @returns #FALSE on failure **/ diff --git a/glib/dbus-glib.c b/glib/dbus-glib.c index 5dbcdf08..332c313f 100644 --- a/glib/dbus-glib.c +++ b/glib/dbus-glib.c @@ -135,7 +135,7 @@ dbus_g_error_quark (void) * than DBUS_GERROR or a code other than * DBUS_GERROR_REMOTE_EXCEPTION). * - * @param gerror the GError given from the remote method + * @param error the GError given from the remote method * @param name the D-BUS error name * @param msg the D-BUS error detailed message * @returns TRUE iff the remote error has the given name @@ -159,7 +159,7 @@ dbus_g_error_has_name (GError *error, const char *name) * Moreover, you must ensure that the error's domain is DBUS_GERROR, * and the code is DBUS_GERROR_REMOTE_EXCEPTION. * - * @param gerror the GError given from the remote method + * @param error the GError given from the remote method * @param name the D-BUS error name * @param msg the D-BUS error detailed message * @returns the D-BUS error name diff --git a/glib/dbus-gobject.c b/glib/dbus-gobject.c index 1dcf4bb9..e6ef38db 100644 --- a/glib/dbus-gobject.c +++ b/glib/dbus-gobject.c @@ -1826,7 +1826,7 @@ dbus_g_object_register_marshaller (GClosureMarshal marshaller, * @param marshaller a GClosureMarshal to be used for invocation * @param rettype a GType for the return type of the function * @param n_types number of function parameters - * @param param_types a C array of GTypes values + * @param types a C array of GTypes values */ void dbus_g_object_register_marshaller_array (GClosureMarshal marshaller, diff --git a/glib/dbus-gproxy.c b/glib/dbus-gproxy.c index 5e53f3ee..9fd46020 100644 --- a/glib/dbus-gproxy.c +++ b/glib/dbus-gproxy.c @@ -2292,7 +2292,7 @@ dbus_g_proxy_begin_call (DBusGProxy *proxy, * The list should be terminated with G_TYPE_INVALID. * * @param proxy a proxy for a remote interface - * @param call_id the pending call ID from dbus_g_proxy_begin_call() + * @param call the pending call ID from dbus_g_proxy_begin_call() * @param error return location for an error * @param first_arg_type type of first "out" argument * @returns #FALSE if an error is set @@ -2412,7 +2412,7 @@ dbus_g_proxy_call_no_reply (DBusGProxy *proxy, * ended with dbus_g_proxy_end_call. * * @param proxy a proxy for a remote interface - * @param call_id the pending call ID from dbus_g_proxy_begin_call() + * @param call the pending call ID from dbus_g_proxy_begin_call() */ void dbus_g_proxy_cancel_call (DBusGProxy *proxy, -- cgit