diff options
| author | Dan Winship <danw@src.gnome.org> | 2004-08-26 15:33:33 +0000 |
|---|---|---|
| committer | Dan Winship <danw@src.gnome.org> | 2004-08-26 15:33:33 +0000 |
| commit | afd1b9daee050c8f127b0a747c336327d1f46e6c (patch) | |
| tree | 24ee20598b421951f31a4c629395098de6d2669e /libsoup/soup-address.c | |
| parent | 8cbb9e013acfcacb00c2caffaad339bf65502e6c (diff) | |
| download | libsoup-afd1b9daee050c8f127b0a747c336327d1f46e6c.tar.gz | |
add/fix lots of gtk-doc comments
* libsoup/*: add/fix lots of gtk-doc comments
* libsoup/soup-misc.c (soup_str_case_hash, soup_str_case_equal):
Fix bug noticed while documenting. (We were using the
locale-case-insensitive functions rather than the g_ascii_ ones.)
* libsoup/soup-message.h (SoupMessageFlags): remove the (never
implemented) NO_PIPELINE and NO_COOKIE flags.
* docs/reference/tmpl/*.sgml: Regenerate, fill in some stuff.
There are still problems here with gtk-doc not recognizing many of
the objects in libsoup...
Diffstat (limited to 'libsoup/soup-address.c')
| -rw-r--r-- | libsoup/soup-address.c | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/libsoup/soup-address.c b/libsoup/soup-address.c index 4450fb22..c4d42ac0 100644 --- a/libsoup/soup-address.c +++ b/libsoup/soup-address.c @@ -200,8 +200,10 @@ soup_address_new (const char *name, guint port) * @sa: a pointer to a sockaddr * @len: size of @sa * - * Return value: a #SoupAddress equivalent to @sa (or %NULL if @sa's + * Returns a #SoupAddress equivalent to @sa (or %NULL if @sa's * address family isn't supported) + * + * Return value: the new #SoupAddress **/ SoupAddress * soup_address_new_from_sockaddr (struct sockaddr *sa, int len) @@ -221,11 +223,13 @@ soup_address_new_from_sockaddr (struct sockaddr *sa, int len) /** * soup_address_new_any: * @family: the address family - * @port: the port number (usually 0, meaning "any port") + * @port: the port number (usually %SOUP_ADDRESS_ANY_PORT) * - * Return value: a #SoupAddress corresponding to the "any" address + * Returns a #SoupAddress corresponding to the "any" address * for @family (or %NULL if @family isn't supported), suitable for * passing to soup_socket_server_new(). + * + * Return value: the new #SoupAddress **/ SoupAddress * soup_address_new_any (SoupAddressFamily family, guint port) @@ -250,8 +254,9 @@ soup_address_new_any (SoupAddressFamily family, guint port) * soup_address_get_name: * @addr: a #SoupAddress * - * Return value: the hostname associated with @addr, or %NULL if - * it is not known. + * Returns the hostname associated with @addr. + * + * Return value: the hostname, or %NULL if it is not known. **/ const char * soup_address_get_name (SoupAddress *addr) @@ -312,7 +317,9 @@ soup_address_get_physical (SoupAddress *addr) * soup_address_get_port: * @addr: a #SoupAddress * - * Return value: the port associated with @addr + * Returns the port associated with @addr. + * + * Return value: the port **/ guint soup_address_get_port (SoupAddress *addr) |