Commit 0a32ee25 authored by Pekka Pessi's avatar Pekka Pessi
Browse files

su: fix documentation

parent 394c0911
......@@ -24,17 +24,17 @@
/**@page addrinfo Resolve network services
*
* @section synopsis Synopsis
* @section addrinfo_synopsis Synopsis
*
* <tt>addrinfo [-pcn46] service-name host</tt>
*
* @section description Description
* @section addrinfo_description Description
*
* The @em addrinfo utility will use su_getaddrinfo() to resolve the network
* services and print resolved names. See sect 6.1 of RFC3493 and the getaddrinfo(3)
* manual page of POSIX 1003.1g, for more information.
*
* @section options Options
* @section addrinfo_options Options
*
* The @e addrinfo utility accepts following ccommand line options:
* <dl>
......@@ -50,13 +50,13 @@
* <dd>IPv6 only (but including mapped IPv4 addresses).</dd>
* </dl>
*
* @section bugs Reporting Bugs
* @section addrinfo_bugs Reporting Bugs
* Report bugs to <sofia-sip-devel@lists.sourceforge.net>.
*
* @section author Author
* @section addrinfo_author Author
* Written by Pekka Pessi <pekka -dot pessi -at- nokia -dot- com>
*
* @section copyright Copyright
* @section addrinfo_copyright Copyright
* Copyright (C) 2005,2007 Nokia Corporation.
*
* This program is free software; see the source for copying conditions.
......
......@@ -24,16 +24,16 @@
/**@page localinfo list local network addresses
*
* @section synopsis Synopsis
* @section localinfo_synopsis Synopsis
*
* <tt>localinfo [-imdn46gslh] [domainname]</tt>
*
* @section description Description
* @section localinfo_description Description
*
* The @em localinfo utility will obtain the local network addresses
* and print them.
*
* @section options Options
* @section localinfo_options Options
*
* The @e localinfo utility accepts following command line options:
* <dl>
......@@ -59,7 +59,7 @@
* <dd>Host-internal addresses.</dd>
* </dl>
*
* @section examples Examples
* @section localinfo_examples Examples
*
* You want to find out local IPv6 addresses:
* @code
......@@ -70,13 +70,13 @@
* $ localinfo -l -n
* @endcode
*
* @section bugs Reporting Bugs
* @section localinfo_bugs Reporting Bugs
* Report bugs to <sofia-sip-devel@lists.sourceforge.net>.
*
* @section author Author
* @section localinfo_author Author
* Written by Pekka Pessi <pekka -dot pessi -at- nokia -dot- com>
*
* @section copyright Copyright
* @section localinfo_copyright Copyright
* Copyright (C) 2005 Nokia Corporation.
*
* This program is free software; see the source for copying conditions.
......
......@@ -47,24 +47,6 @@
* level.
*/
/**@maindefgroup su OS Utilities
*
* The "su" module contains OS utilies for Sofia.
*
* The @b su is a simple, portable socket/timing/synchronizing library
* developed for Sofia communications software. Currently, interface to
* it consists of following parts:
*
* - <sofia-sip/su_types.h> - basic integer types
* - <a href=group_su_socket.html>su_socket</a> - socket functions
* - <a href=group_su_wait.html>su_wait</a> - synchronization functions
* - <a href=group_su_time.html>su_time</a> - time functions
* - <a href=group_su_alloc.html>su_alloc</a> - memory management functions
* - <a href=group_su_log.html>su_log</a> - generic logging functions
* - <a href=group_su_tag.html>su_tag</a> - tag list function
* - <a href=group_su_md5.html>su_md5</a> - MD5 hashing
*/
/**@defgroup su_programs Shell Programs
*
* The @b su module provides few shell utilities:
......
......@@ -422,6 +422,7 @@ su_root_clone_initializer(su_root_t *root,
*
* Allocate and initialize the instance of su_root_t.
*
* @param self pointer to a root object.
* @param magic pointer to user data
*
* @return A pointer to allocated su_root_t instance, NULL on error.
......@@ -713,7 +714,7 @@ int su_root_set_max_defer(su_root_t *self, su_duration_t max_defer)
* activated, however, they are deferred no longer than the maximum defer
* time. The maximum defer time is 15 seconds by default.
*
* @param root pointer to root object
* @param self pointer to root object
*
* @return Maximum defer time
*
......
......@@ -178,14 +178,12 @@ su_strncasecmp(char const *s1,
}
}
/** Check if two strings match.
/** Check if two strings match.
*
* Compare two strings. Accept NULL arguments: two NULL pointers match each
* other, but otherwise NULL pointer does not match anything else, not even
* empty string.
*
* @param s1
*
* @retval One if @a s1 matches @a s2
* @retval Zero if @a s1 does not match @a s2
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment