From 15ef0ef6fbba7827453b7973e62b6c1853576601 Mon Sep 17 00:00:00 2001 From: Havoc Pennington Date: Fri, 20 Oct 2006 03:05:00 +0000 Subject: 2006-10-19 Havoc Pennington * Fix a pile of Doxygen warnings and missing docs --- dbus/dbus-address.c | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'dbus/dbus-address.c') diff --git a/dbus/dbus-address.c b/dbus/dbus-address.c index c6354f14..d92209d9 100644 --- a/dbus/dbus-address.c +++ b/dbus/dbus-address.c @@ -49,8 +49,20 @@ struct DBusAddressEntry }; +/** + * + * Sets #DBUS_ERROR_BAD_ADDRESS. + * If address_problem_type and address_problem_field are not #NULL, + * sets an error message about how the field is no good. Otherwise, sets + * address_problem_other as the error message. + * + * @param error the error to set + * @param address_problem_type the address type of the bad address or #NULL + * @param address_problem_field the missing field of the bad address or #NULL + * @param address_problem_other any other error message or #NULL + */ void -_dbus_set_bad_address (DBusError *error, +_dbus_set_bad_address (DBusError *error, const char *address_problem_type, const char *address_problem_field, const char *address_problem_other) @@ -65,6 +77,10 @@ _dbus_set_bad_address (DBusError *error, address_problem_other); } +/** + * #TRUE if the byte need not be escaped when found in a dbus address. + * All other bytes are required to be escaped in a valid address. + */ #define _DBUS_ADDRESS_OPTIONALLY_ESCAPED_BYTE(b) \ (((b) >= 'a' && (b) <= 'z') || \ ((b) >= 'A' && (b) <= 'Z') || \ @@ -615,6 +631,9 @@ dbus_address_unescape_value (const char *value, /** @} */ /* End of public API */ #ifdef DBUS_BUILD_TESTS + +#ifndef DOXYGEN_SHOULD_SKIP_THIS + #include "dbus-test.h" #include @@ -782,4 +801,6 @@ _dbus_address_test (void) return TRUE; } +#endif /* !DOXYGEN_SHOULD_SKIP_THIS */ + #endif -- cgit