From f3e0afcd508fd418b906ae156bc18516468a3caf Mon Sep 17 00:00:00 2001 From: Dan Winship Date: Tue, 4 Nov 2008 21:08:30 +0000 Subject: [PATCH] misc doc fixes * libsoup/soup-address.c (soup_address_is_resolved): * libsoup/soup-cookie.c (soup_cookie_copy): * libsoup/soup-cookie-jar.c (soup_cookie_jar_class_init): * libsoup/soup-message-headers.c (SoupMessageHeadersType): * libsoup/soup-proxy-resolver.c (soup_proxy_resolver_get_proxy_async) (soup_proxy_resolver_get_proxy_sync): * libsoup/soup-status.c (soup_status_proxyify): misc doc fixes * libsoup/soup-cookie-jar-text.h: remove a "deprecated" API that was never actually released * libsoup/soup.h: include soup-proxy-resolver.h * docs/reference/Makefile.am (SCAN_OPTIONS): set --deprecated-guards correctly (IGNORE_HFILES): ignore some more internal files (GTKDOC_LIBS): link against libsoup-gnome, not libsoup * docs/reference/libsoup-2.4-docs.sgml: * docs/reference/libsoup-2.4.types: * docs/reference/libsoup-2.4-sections.txt: add new stuff svn path=/trunk/; revision=1201 --- ChangeLog | 25 ++++++++++ docs/reference/Makefile.am | 8 ++-- docs/reference/libsoup-2.4-docs.sgml | 8 ++++ docs/reference/libsoup-2.4-sections.txt | 82 +++++++++++++++++++++++++++++++++ docs/reference/libsoup-2.4.types | 5 +- libsoup/soup-address.c | 8 ++++ libsoup/soup-cookie-jar-text.h | 3 -- libsoup/soup-cookie-jar.c | 14 ++++++ libsoup/soup-cookie.c | 2 + libsoup/soup-message-headers.c | 1 + libsoup/soup-proxy-resolver.c | 4 +- libsoup/soup-status.c | 4 +- libsoup/soup.h | 1 + 13 files changed, 154 insertions(+), 11 deletions(-) diff --git a/ChangeLog b/ChangeLog index 67f5d59..ce2e977 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,30 @@ 2008-11-04 Dan Winship + * libsoup/soup-address.c (soup_address_is_resolved): + * libsoup/soup-cookie.c (soup_cookie_copy): + * libsoup/soup-cookie-jar.c (soup_cookie_jar_class_init): + * libsoup/soup-message-headers.c (SoupMessageHeadersType): + * libsoup/soup-proxy-resolver.c + (soup_proxy_resolver_get_proxy_async) + (soup_proxy_resolver_get_proxy_sync): + * libsoup/soup-status.c (soup_status_proxyify): misc doc fixes + + * libsoup/soup-cookie-jar-text.h: remove a "deprecated" API that + was never actually released + + * libsoup/soup.h: include soup-proxy-resolver.h + + * docs/reference/Makefile.am (SCAN_OPTIONS): set + --deprecated-guards correctly + (IGNORE_HFILES): ignore some more internal files + (GTKDOC_LIBS): link against libsoup-gnome, not libsoup + + * docs/reference/libsoup-2.4-docs.sgml: + * docs/reference/libsoup-2.4.types: + * docs/reference/libsoup-2.4-sections.txt: add new stuff + +2008-11-04 Dan Winship + * libsoup/soup-cookie-jar-text.c: implementation of SoupCookieJar that persists to a text file in the old Mozilla cookies.txt format. diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index c27c2c6..294cc4f 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -13,7 +13,7 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml DOC_SOURCE_DIR=../../libsoup # Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= +SCAN_OPTIONS=--deprecated-guards=LIBSOUP_DISABLE_DEPRECATED # Extra options to supply to gtkdoc-scangobj. SCANGOBJ_OPTIONS=--type-init-func 'g_type_init(); g_thread_init(NULL)' @@ -35,7 +35,9 @@ IGNORE_HFILES= soup.h soup-marshal.h \ soup-auth-basic.h soup-auth-digest.h soup-auth-ntlm.h \ soup-connection.h soup-connection-ntlm.h \ soup-dns.h soup-auth-manager.h soup-auth-manager-ntlm.h \ - soup-message-queue.h soup-path-map.h soup-ssl.h + soup-message-queue.h soup-path-map.h soup-ssl.h \ + soup-proxy-resolver-libproxy.h soup-proxy-resolver-gconf.h \ + soup-proxy-resolver-static.h # Images to copy into HTML directory. HTML_IMAGES = @@ -55,7 +57,7 @@ GTKDOC_CFLAGS = \ $(XML_CFLAGS) \ $(GNUTLS_CFLAGS) -GTKDOC_LIBS = $(top_builddir)/libsoup/libsoup-2.4.la $(GLIB_LIBS) +GTKDOC_LIBS = $(top_builddir)/libsoup/libsoup-gnome-2.4.la # include common portion ... include $(top_srcdir)/gtk-doc.make diff --git a/docs/reference/libsoup-2.4-docs.sgml b/docs/reference/libsoup-2.4-docs.sgml index 25cd2af..3ca31bd 100644 --- a/docs/reference/libsoup-2.4-docs.sgml +++ b/docs/reference/libsoup-2.4-docs.sgml @@ -21,12 +21,14 @@ + + @@ -44,6 +46,12 @@ + GNOME integration + + + + + Low-level Networking API diff --git a/docs/reference/libsoup-2.4-sections.txt b/docs/reference/libsoup-2.4-sections.txt index dea6b6c..283a005 100644 --- a/docs/reference/libsoup-2.4-sections.txt +++ b/docs/reference/libsoup-2.4-sections.txt @@ -13,6 +13,7 @@ soup_message_set_http_version soup_message_get_http_version soup_message_get_uri soup_message_set_uri +soup_message_get_address soup_message_set_status soup_message_set_status_full @@ -171,6 +172,7 @@ SOUP_STATUS_IS_CLIENT_ERROR SOUP_STATUS_IS_SERVER_ERROR SoupKnownStatusCode soup_status_get_phrase +soup_status_proxify SOUP_HTTP_ERROR @@ -325,12 +327,18 @@ soup_address_new_any SoupAddressCallback soup_address_resolve_async soup_address_resolve_sync +soup_address_is_resolved soup_address_get_name soup_address_get_sockaddr soup_address_get_physical soup_address_get_port +soup_address_equal_by_name +soup_address_hash_by_name +soup_address_equal_by_ip +soup_address_hash_by_ip + SOUP_ADDRESS_FAMILY SOUP_ADDRESS_NAME SOUP_ADDRESS_PHYSICAL @@ -712,6 +720,8 @@ SOUP_TYPE_LOGGER SoupCookie soup_cookie_new soup_cookie_parse +soup_cookie_copy +soup_cookie_equal soup_cookie_free soup_cookie_set_name @@ -738,6 +748,9 @@ soup_cookies_to_request soup_cookies_to_response soup_cookies_to_cookie_header soup_cookies_free + +SOUP_TYPE_COOKIE +soup_cookie_get_type
@@ -748,6 +761,12 @@ soup_cookie_jar_new soup_cookie_jar_save soup_cookie_jar_get_cookies soup_cookie_jar_set_cookie + +soup_cookie_jar_add_cookie +soup_cookie_jar_delete_cookie +soup_cookie_jar_all_cookies + +SOUP_COOKIE_JAR_READ_ONLY SoupCookieJarClass SOUP_COOKIE_JAR @@ -777,3 +796,66 @@ soup_multipart_to_message SOUP_TYPE_MULTIPART soup_multipart_get_type
+ +
+soup-cookie-jar-text +SoupCookieJarText +SoupCookieJarText +soup_cookie_jar_text_new + +SOUP_COOKIE_JAR_TEXT_FILENAME + +SoupCookieJarTextClass +SOUP_COOKIE_JAR_TEXT +SOUP_COOKIE_JAR_TEXT_CLASS +SOUP_COOKIE_JAR_TEXT_GET_CLASS +SOUP_TYPE_COOKIE_JAR_TEXT +SOUP_IS_COOKIE_JAR_TEXT +SOUP_IS_COOKIE_JAR_TEXT_CLASS +soup_cookie_jar_text_get_type +
+ +
+soup-cookie-jar-sqlite +SoupCookieJarSqlite +SoupCookieJarSqlite +soup_cookie_jar_sqlite_new + +SOUP_COOKIE_JAR_SQLITE_FILENAME + +SoupCookieJarSqliteClass +SOUP_COOKIE_JAR_SQLITE +SOUP_COOKIE_JAR_SQLITE_CLASS +SOUP_COOKIE_JAR_SQLITE_GET_CLASS +SOUP_TYPE_COOKIE_JAR_SQLITE +SOUP_IS_COOKIE_JAR_SQLITE +SOUP_IS_COOKIE_JAR_SQLITE_CLASS +soup_cookie_jar_sqlite_get_type +
+ +
+soup-proxy-resolver +SoupProxyResolver +SoupProxyResolver +SoupProxyResolverCallback +soup_proxy_resolver_get_proxy_async +soup_proxy_resolver_get_proxy_sync + +SoupProxyResolverInterface +SOUP_PROXY_RESOLVER +SOUP_PROXY_RESOLVER_CLASS +SOUP_PROXY_RESOLVER_GET_CLASS +SOUP_TYPE_PROXY_RESOLVER +SOUP_IS_PROXY_RESOLVER +SOUP_IS_PROXY_RESOLVER_CLASS +soup_proxy_resolver_get_type +
+ +
+soup-gnome-features +SOUP_TYPE_GNOME_FEATURES_2_26 +SOUP_TYPE_PROXY_RESOLVER_GNOME + +soup_proxy_resolver_gnome_get_type +soup_gnome_features_2_26_get_type +
diff --git a/docs/reference/libsoup-2.4.types b/docs/reference/libsoup-2.4.types index a342980..ae7a4b2 100644 --- a/docs/reference/libsoup-2.4.types +++ b/docs/reference/libsoup-2.4.types @@ -1,4 +1,4 @@ -#include +#include soup_address_get_type soup_auth_get_type @@ -6,8 +6,11 @@ soup_auth_domain_get_type soup_auth_domain_basic_get_type soup_auth_domain_digest_get_type soup_cookie_jar_get_type +soup_cookie_jar_text_get_type +soup_cookie_jar_sqlite_get_type soup_logger_get_type soup_message_get_type +soup_proxy_resolver_get_type soup_server_get_type soup_session_get_type soup_session_sync_get_type diff --git a/libsoup/soup-address.c b/libsoup/soup-address.c index 4a24569..d2d4a54 100644 --- a/libsoup/soup-address.c +++ b/libsoup/soup-address.c @@ -629,6 +629,14 @@ soup_address_resolve_sync (SoupAddress *addr, GCancellable *cancellable) return status; } +/** + * soup_address_is_resolved: + * @addr: a #SoupAddress + * + * Tests if @addr has already been resolved. + * + * Return value: %TRUE if @addr has been resolved. + **/ gboolean soup_address_is_resolved (SoupAddress *addr) { diff --git a/libsoup/soup-cookie-jar-text.h b/libsoup/soup-cookie-jar-text.h index e23c90e..d81a996 100644 --- a/libsoup/soup-cookie-jar-text.h +++ b/libsoup/soup-cookie-jar-text.h @@ -31,9 +31,6 @@ typedef struct { } SoupCookieJarTextClass; #define SOUP_COOKIE_JAR_TEXT_FILENAME "filename" -#ifndef LIBSOUP_DISABLE_DEPRECATED -#define SOUP_COOKIE_JAR_TEXT_READ_ONLY SOUP_COOKIE_JAR_READ_ONLY -#endif GType soup_cookie_jar_text_get_type (void); diff --git a/libsoup/soup-cookie-jar.c b/libsoup/soup-cookie-jar.c index 29a2de1..b3d02be 100644 --- a/libsoup/soup-cookie-jar.c +++ b/libsoup/soup-cookie-jar.c @@ -116,6 +116,20 @@ soup_cookie_jar_class_init (SoupCookieJarClass *jar_class) object_class->set_property = set_property; object_class->get_property = get_property; + /** + * SoupCookieJar::changed + * @jar: the #SoupCookieJar + * @old_cookie: the old #SoupCookie value + * @new_cookie: the new #SoupCookie value + * + * Emitted when @jar changes. If a cookie has been added, + * @new_cookie will contain the newly-added cookie and + * @old_cookie will be %NULL. If a cookie has been deleted, + * @old_cookie will contain the to-be-deleted cookie and + * @new_cookie will be %NULL. If a cookie has been changed, + * @old_cookie will contain its old value, and @new_cookie its + * new value. + **/ signals[CHANGED] = g_signal_new ("changed", G_OBJECT_CLASS_TYPE (object_class), diff --git a/libsoup/soup-cookie.c b/libsoup/soup-cookie.c index a002563..d009220 100644 --- a/libsoup/soup-cookie.c +++ b/libsoup/soup-cookie.c @@ -142,6 +142,8 @@ soup_cookie_get_type (void) * @cookie: a #SoupCookie * * Copies @cookie. + * + * Return value: a copy of @cookie **/ SoupCookie * soup_cookie_copy (SoupCookie *cookie) diff --git a/libsoup/soup-message-headers.c b/libsoup/soup-message-headers.c index b5e9f59..fba51c0 100644 --- a/libsoup/soup-message-headers.c +++ b/libsoup/soup-message-headers.c @@ -25,6 +25,7 @@ * SoupMessageHeadersType: * @SOUP_MESSAGE_HEADERS_REQUEST: request headers * @SOUP_MESSAGE_HEADERS_RESPONSE: response headers + * @SOUP_MESSAGE_HEADERS_MULTIPART: multipart body part headers * * Value passed to soup_message_headers_new() to set certain default * behaviors. diff --git a/libsoup/soup-proxy-resolver.c b/libsoup/soup-proxy-resolver.c index 045b277..3085ff7 100644 --- a/libsoup/soup-proxy-resolver.c +++ b/libsoup/soup-proxy-resolver.c @@ -34,7 +34,7 @@ soup_proxy_resolver_get_type (void) } /** - * soup_proxy_resovler_get_proxy_async: + * soup_proxy_resolver_get_proxy_async: * @proxy_resolver: the #SoupProxyResolver * @msg: the #SoupMessage you want a proxy for * @async_context: the #GMainContext to invoke @callback in @@ -60,7 +60,7 @@ soup_proxy_resolver_get_proxy_async (SoupProxyResolver *proxy_resolver, } /** - * soup_proxy_resovler_get_proxy_sync: + * soup_proxy_resolver_get_proxy_sync: * @proxy_resolver: the #SoupProxyResolver * @msg: the #SoupMessage you want a proxy for * @cancellable: a #GCancellable, or %NULL diff --git a/libsoup/soup-status.c b/libsoup/soup-status.c index 4d12ed3..c8527f7 100644 --- a/libsoup/soup-status.c +++ b/libsoup/soup-status.c @@ -250,13 +250,13 @@ soup_status_get_phrase (guint status_code) /** * soup_status_proxify: - * @status: a status code + * @status_code: a status code * * Turns SOUP_STATUS_CANT_RESOLVE into SOUP_STATUS_CANT_RESOLVE_PROXY * and SOUP_STATUS_CANT_CONNECT into SOUP_STATUS_CANT_CONNECT_PROXY. * Other status codes are passed through unchanged. * - * Return value: the "proxified" equivalent of @status. + * Return value: the "proxified" equivalent of @status_code. **/ guint soup_status_proxify (guint status_code) diff --git a/libsoup/soup.h b/libsoup/soup.h index e973fe8..496a4c1 100644 --- a/libsoup/soup.h +++ b/libsoup/soup.h @@ -27,6 +27,7 @@ extern "C" { #include #include #include +#include #include #include #include -- 2.7.4