From 5af7f409b4947ee6daa18590ed3bed15a18ad00b Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Thu, 15 Mar 2012 14:25:40 +0000 Subject: -doxygen fixes, add 'const' --- src/include/gnunet_strings_lib.h | 48 ++++++++++++++++++++++++---------------- src/util/strings.c | 30 +++++++++++++------------ 2 files changed, 45 insertions(+), 33 deletions(-) diff --git a/src/include/gnunet_strings_lib.h b/src/include/gnunet_strings_lib.h index 2beaa9534..1772b03bf 100644 --- a/src/include/gnunet_strings_lib.h +++ b/src/include/gnunet_strings_lib.h @@ -284,39 +284,43 @@ int GNUNET_STRINGS_parse_uri (const char *path, char **scheme_part, const char **path_part); + /** - * Check whether @filename is absolute or not, and if it's an URI + * Check whether filename is absolute or not, and if it's an URI * * @param filename filename to check * @param can_be_uri GNUNET_YES to check for being URI, GNUNET_NO - to * assume it's not URI - * @param r_is_uri a pointer to an int that is set to GNUNET_YES if @filename - * is URI and to GNUNET_NO otherwise. Can be NULL. If @can_be_uri is + * @param r_is_uri a pointer to an int that is set to GNUNET_YES if 'filename' + * is URI and to GNUNET_NO otherwise. Can be NULL. If 'can_be_uri' is * not GNUNET_YES, *r_is_uri is set to GNUNET_NO. * @param r_uri a pointer to a char * that is set to a pointer to URI scheme. * The string is allocated by the function, and should be freed with * GNUNET_free (). Can be NULL. - * @return GNUNET_YES if @filaneme is absolute, GNUNET_NO otherwise. + * @return GNUNET_YES if 'filaname' is absolute, GNUNET_NO otherwise. */ int -GNUNET_STRINGS_path_is_absolute (const char *filename, int can_be_uri, - int *r_is_uri, char **r_uri_scheme); +GNUNET_STRINGS_path_is_absolute (const char *filename, + int can_be_uri, + int *r_is_uri, + char **r_uri_scheme); + /** - * Perform @checks on @filename + * Perform checks on 'filename; * * @param filename file to check * @param checks checks to perform - * @return GNUNET_YES if all @checks pass, GNUNET_NO if at least one of them + * @return GNUNET_YES if all checks pass, GNUNET_NO if at least one of them * fails, GNUNET_SYSERR when a check can't be performed */ int GNUNET_STRINGS_check_filename (const char *filename, - enum GNUNET_STRINGS_FilenameCheck checks); + enum GNUNET_STRINGS_FilenameCheck checks); /** - * Tries to convert @zt_addr string to an IPv6 address. + * Tries to convert 'zt_addr' string to an IPv6 address. * * @param zt_addr 0-terminated string. May be mangled by the function. * @param addrlen length of zt_addr (not counting 0-terminator). @@ -326,11 +330,13 @@ GNUNET_STRINGS_check_filename (const char *filename, * case the contents of r_buf are undefined. */ int -GNUNET_STRINGS_to_address_ipv6 (char *zt_addr, uint16_t addrlen, - struct sockaddr_in6 *r_buf); +GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr, + uint16_t addrlen, + struct sockaddr_in6 *r_buf); + /** - * Tries to convert @zt_addr string to an IPv4 address. + * Tries to convert 'zt_addr' string to an IPv4 address. * * @param zt_addr 0-terminated string. May be mangled by the function. * @param addrlen length of zt_addr (not counting 0-terminator). @@ -339,14 +345,16 @@ GNUNET_STRINGS_to_address_ipv6 (char *zt_addr, uint16_t addrlen, * the contents of r_buf are undefined. */ int -GNUNET_STRINGS_to_address_ipv4 (char *zt_addr, uint16_t addrlen, - struct sockaddr_in *r_buf); +GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr, + uint16_t addrlen, + struct sockaddr_in *r_buf); + /** - * Tries to convert @addr string to an IP (v4 or v6) address. + * Tries to convert 'addr' string to an IP (v4 or v6) address. * IPv6 address must have its address part enclosed in '()' parens * instead of '[]'. - * Will automatically decide whether to treat @addr as v4 or v6 address. + * Will automatically decide whether to treat 'addr' as v4 or v6 address. * * @param addr a string, may not be 0-terminated. * @param addrlen number of bytes in addr (if addr is 0-terminated, @@ -356,8 +364,10 @@ GNUNET_STRINGS_to_address_ipv4 (char *zt_addr, uint16_t addrlen, * case the contents of r_buf are undefined. */ int -GNUNET_STRINGS_to_address_ip (const char *addr, uint16_t addrlen, - struct sockaddr_storage *r_buf); +GNUNET_STRINGS_to_address_ip (const char *addr, + uint16_t addrlen, + struct sockaddr_storage *r_buf); + /* ifndef GNUNET_UTIL_STRING_H */ #endif diff --git a/src/util/strings.c b/src/util/strings.c index 0d58ec567..37500b45b 100644 --- a/src/util/strings.c +++ b/src/util/strings.c @@ -921,7 +921,7 @@ GNUNET_STRINGS_path_is_absolute (const char *filename, int can_be_uri, */ int GNUNET_STRINGS_check_filename (const char *filename, - enum GNUNET_STRINGS_FilenameCheck checks) + enum GNUNET_STRINGS_FilenameCheck checks) { struct stat st; if (filename == NULL || filename[0] == '\0') @@ -954,8 +954,9 @@ GNUNET_STRINGS_check_filename (const char *filename, #define MAX_IPV4_ADDRLEN 21 #define MAX_IP_ADDRLEN MAX_IPV6_ADDRLEN + /** - * Tries to convert @zt_addr string to an IPv6 address. + * Tries to convert 'zt_addr' string to an IPv6 address. * * @param zt_addr 0-terminated string. May be mangled by the function. * @param addrlen length of zt_addr (not counting 0-terminator). @@ -965,8 +966,9 @@ GNUNET_STRINGS_check_filename (const char *filename, * case the contents of r_buf are undefined. */ int -GNUNET_STRINGS_to_address_ipv6 (char *zt_addr, uint16_t addrlen, - struct sockaddr_in6 *r_buf) +GNUNET_STRINGS_to_address_ipv6 (const char *zt_addr, + uint16_t addrlen, + struct sockaddr_in6 *r_buf) { int ret; char *port_colon; @@ -982,7 +984,6 @@ GNUNET_STRINGS_to_address_ipv6 (char *zt_addr, uint16_t addrlen, if (ret != 1 || port > 65535) return GNUNET_SYSERR; port_colon[0] = '\0'; - memset (r_buf, 0, sizeof (struct sockaddr_in6)); ret = inet_pton (AF_INET6, zt_addr, &r_buf->sin6_addr); if (ret <= 0) @@ -992,8 +993,9 @@ GNUNET_STRINGS_to_address_ipv6 (char *zt_addr, uint16_t addrlen, return GNUNET_OK; } + /** - * Tries to convert @zt_addr string to an IPv4 address. + * Tries to convert 'zt_addr' string to an IPv4 address. * * @param zt_addr 0-terminated string. May be mangled by the function. * @param addrlen length of zt_addr (not counting 0-terminator). @@ -1002,8 +1004,8 @@ GNUNET_STRINGS_to_address_ipv6 (char *zt_addr, uint16_t addrlen, * the contents of r_buf are undefined. */ int -GNUNET_STRINGS_to_address_ipv4 (char *zt_addr, uint16_t addrlen, - struct sockaddr_in *r_buf) +GNUNET_STRINGS_to_address_ipv4 (const char *zt_addr, uint16_t addrlen, + struct sockaddr_in *r_buf) { unsigned int temps[5]; unsigned int port; @@ -1030,10 +1032,10 @@ GNUNET_STRINGS_to_address_ipv4 (char *zt_addr, uint16_t addrlen, } /** - * Tries to convert @addr string to an IP (v4 or v6) address. + * Tries to convert 'addr' string to an IP (v4 or v6) address. * IPv6 address must have its address part enclosed in '()' parens * instead of '[]'. - * Will automatically decide whether to treat @addr as v4 or v6 address. + * Will automatically decide whether to treat 'addr' as v4 or v6 address. * * @param addr a string, may not be 0-terminated. * @param addrlen number of bytes in addr (if addr is 0-terminated, @@ -1043,8 +1045,9 @@ GNUNET_STRINGS_to_address_ipv4 (char *zt_addr, uint16_t addrlen, * case the contents of r_buf are undefined. */ int -GNUNET_STRINGS_to_address_ip (const char *addr, uint16_t addrlen, - struct sockaddr_storage *r_buf) +GNUNET_STRINGS_to_address_ip (const char *addr, + uint16_t addrlen, + struct sockaddr_storage *r_buf) { uint16_t i; char zt_addr[MAX_IP_ADDRLEN + 1]; @@ -1078,8 +1081,7 @@ GNUNET_STRINGS_to_address_ip (const char *addr, uint16_t addrlen, } return GNUNET_STRINGS_to_address_ipv6 (zt_addr, zt_len, (struct sockaddr_in6 *) r_buf); } - else - return GNUNET_STRINGS_to_address_ipv4 (zt_addr, zt_len, (struct sockaddr_in *) r_buf); + return GNUNET_STRINGS_to_address_ipv4 (zt_addr, zt_len, (struct sockaddr_in *) r_buf); } /* end of strings.c */ -- cgit v1.2.3