From 4b13bb6d7f9a8e240cc41466dc70d9beb912a35e Mon Sep 17 00:00:00 2001 From: Anders Carlsson Date: Wed, 26 Mar 2003 19:21:42 +0000 Subject: [PATCH] 2003-03-26 Anders Carlsson * Doxyfile.in: * dbus/dbus-address.c: * dbus/dbus-dict.c: * dbus/dbus-marshal.c: * dbus/dbus-server-debug-pipe.c: * dbus/dbus-transport-unix.c: Fix documentation warnings. --- ChangeLog | 10 ++++++++++ Doxyfile.in | 7 +++++-- dbus/dbus-address.c | 2 +- dbus/dbus-marshal.c | 1 + dbus/dbus-server-debug-pipe.c | 2 +- dbus/dbus-transport-unix.c | 4 ++-- 6 files changed, 20 insertions(+), 6 deletions(-) diff --git a/ChangeLog b/ChangeLog index cb0f041..5b6f070 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,13 @@ +2003-03-26 Anders Carlsson + + * Doxyfile.in: + * dbus/dbus-address.c: + * dbus/dbus-dict.c: + * dbus/dbus-marshal.c: + * dbus/dbus-server-debug-pipe.c: + * dbus/dbus-transport-unix.c: + Fix documentation warnings. + 2003-03-26 Havoc Pennington * bus/test-main.c, dbus/dbus-test.c (main): check memleaks diff --git a/Doxyfile.in b/Doxyfile.in index c476deb..b2ac958 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -143,8 +143,11 @@ EXPAND_ONLY_PREDEF = YES SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -PREDEFINED = "DBUS_BEGIN_DECLS=" "DBUS_END_DECLS=" "DOXYGEN_SHOULD_SKIP_THIS" -EXPAND_AS_DEFINED = +PREDEFINED = "DBUS_BEGIN_DECLS=" \ + "DBUS_END_DECLS=" \ + "DOXYGEN_SHOULD_SKIP_THIS" \ + "_DBUS_DEFINE_GLOBAL_LOCK(name)=" \ + "_DBUS_GNUC_PRINTF(from,to)=" SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::addtions related to external references diff --git a/dbus/dbus-address.c b/dbus/dbus-address.c index ff0ba3b..5effe4d 100644 --- a/dbus/dbus-address.c +++ b/dbus/dbus-address.c @@ -170,7 +170,7 @@ dbus_address_entry_get_value (DBusAddressEntry *entry, * @param address the address. * @param entry return location to an array of entries. * @param array_len return location for array length. - * @param result return location for result code. + * @param error address where an error can be returned. * @returns #TRUE on success, #FALSE otherwise. */ dbus_bool_t diff --git a/dbus/dbus-marshal.c b/dbus/dbus-marshal.c index 8920dfd..51c4ce1 100644 --- a/dbus/dbus-marshal.c +++ b/dbus/dbus-marshal.c @@ -829,6 +829,7 @@ _dbus_demarshal_string (const DBusString *str, * @param str the string containing the data * @param byte_order the byte order * @param pos the position in the string + * @param new_pos the new position of the string * @param array the array * @param array_len length of the demarshaled data diff --git a/dbus/dbus-server-debug-pipe.c b/dbus/dbus-server-debug-pipe.c index 261ee60..c6dc9f7 100644 --- a/dbus/dbus-server-debug-pipe.c +++ b/dbus/dbus-server-debug-pipe.c @@ -209,7 +209,7 @@ _dbus_server_debug_pipe_new (const char *server_name, * given debug-pipe server name. * * @param server_name name of server to connect to - * @param result return location for result + * @param error address where an error can be returned. * @returns #NULL on no memory or transport */ DBusTransport* diff --git a/dbus/dbus-transport-unix.c b/dbus/dbus-transport-unix.c index 35eccb8..d34565e 100644 --- a/dbus/dbus-transport-unix.c +++ b/dbus/dbus-transport-unix.c @@ -1028,7 +1028,7 @@ _dbus_transport_new_for_fd (int fd, * * @param path the path to the domain socket. * @param server #TRUE if this transport is on the server side of a connection - * @param error location to store reason for failure. + * @param error address where an error can be returned. * @returns a new transport, or #NULL on failure. */ DBusTransport* @@ -1070,7 +1070,7 @@ _dbus_transport_new_for_domain_socket (const char *path, * @param host the host to connect to * @param port the port to connect to * @param server #TRUE if this transport is on the server side of a connection - * @param result location to store reason for failure. + * @param error location to store reason for failure. * @returns a new transport, or #NULL on failure. */ DBusTransport* -- 2.7.4