diff options
28 files changed, 678 insertions, 0 deletions
@@ -1,3 +1,8 @@ +2009-03-08 Dan Winship <danw@gnome.org> + + * libsoup/*.c: gtk-doc updates. In particular, document a bunch of + convenience #defines, and add "Since" tags where appropriate. + 2009-03-06 Dan Winship <danw@gnome.org> * libsoup/soup-session-async.c (run_queue): Process messages in diff --git a/libsoup/soup-address.c b/libsoup/soup-address.c index d2d4a546..20415805 100644 --- a/libsoup/soup-address.c +++ b/libsoup/soup-address.c @@ -167,6 +167,12 @@ soup_address_class_init (SoupAddressClass *address_class) object_class->get_property = get_property; /* properties */ + /** + * SOUP_ADDRESS_NAME: + * + * Alias for the #SoupAddress:name property. (The hostname for + * this address.) + **/ g_object_class_install_property ( object_class, PROP_NAME, g_param_spec_string (SOUP_ADDRESS_NAME, @@ -174,6 +180,12 @@ soup_address_class_init (SoupAddressClass *address_class) "Hostname for this address", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_ADDRESS_FAMILY: + * + * Alias for the #SoupAddress:family property. (The + * #SoupAddressFamily for this address.) + **/ g_object_class_install_property ( object_class, PROP_FAMILY, g_param_spec_enum (SOUP_ADDRESS_FAMILY, @@ -182,6 +194,12 @@ soup_address_class_init (SoupAddressClass *address_class) SOUP_TYPE_ADDRESS_FAMILY, SOUP_ADDRESS_FAMILY_INVALID, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_ADDRESS_PORT: + * + * An alias for the #SoupAddress:port property. (The port for + * this address.) + **/ g_object_class_install_property ( object_class, PROP_PORT, g_param_spec_int (SOUP_ADDRESS_PORT, @@ -189,6 +207,12 @@ soup_address_class_init (SoupAddressClass *address_class) "Port for this address", -1, 65535, -1, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_ADDRESS_PHYSICAL: + * + * An alias for the #SoupAddress:physical property. (The + * stringified IP address for this address.) + **/ g_object_class_install_property ( object_class, PROP_PHYSICAL, g_param_spec_string (SOUP_ADDRESS_PHYSICAL, @@ -196,6 +220,12 @@ soup_address_class_init (SoupAddressClass *address_class) "IP address for this address", NULL, G_PARAM_READABLE)); + /** + * SOUP_ADDRESS_SOCKADDR: + * + * An alias for the #SoupAddress:sockaddr property. (A pointer + * to the struct sockaddr for this address.) + **/ g_object_class_install_property ( object_class, PROP_SOCKADDR, g_param_spec_pointer (SOUP_ADDRESS_SOCKADDR, @@ -656,6 +686,8 @@ soup_address_is_resolved (SoupAddress *addr) * soup_address_equal_by_name(), qv * * Return value: the named-based hash value for @addr. + * + * Since: 2.26 **/ guint soup_address_hash_by_name (gconstpointer addr) @@ -694,6 +726,8 @@ soup_address_hash_by_name (gconstpointer addr) * rather than by name. * * Return value: whether or not @addr1 and @addr2 have the same name + * + * Since: 2.26 **/ gboolean soup_address_equal_by_name (gconstpointer addr1, gconstpointer addr2) @@ -714,6 +748,8 @@ soup_address_equal_by_name (gconstpointer addr1, gconstpointer addr2) * soup_address_equal_by_ip(), qv * * Return value: the IP-based hash value for @addr. + * + * Since: 2.26 **/ guint soup_address_hash_by_ip (gconstpointer addr) @@ -748,6 +784,8 @@ soup_address_hash_by_ip (gconstpointer addr) * * Return value: whether or not @addr1 and @addr2 have the same IP * address. + * + * Since: 2.26 **/ gboolean soup_address_equal_by_ip (gconstpointer addr1, gconstpointer addr2) diff --git a/libsoup/soup-auth-domain-basic.c b/libsoup/soup-auth-domain-basic.c index 19329b96..6d515914 100644 --- a/libsoup/soup-auth-domain-basic.c +++ b/libsoup/soup-auth-domain-basic.c @@ -92,12 +92,24 @@ soup_auth_domain_basic_class_init (SoupAuthDomainBasicClass *basic_class) object_class->set_property = set_property; object_class->get_property = get_property; + /** + * SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK: + * + * Alias for the #SoupAuthDomainBasic:auth-callback property. + * (The #SoupAuthDomainBasicAuthCallback.) + **/ g_object_class_install_property ( object_class, PROP_AUTH_CALLBACK, g_param_spec_pointer (SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK, "Authentication callback", "Password-checking callback", G_PARAM_READWRITE)); + /** + * SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA: + * + * Alias for the #SoupAuthDomainBasic:auth-data property. + * (The data to pass to the #SoupAuthDomainBasicAuthCallback.) + **/ g_object_class_install_property ( object_class, PROP_AUTH_DATA, g_param_spec_pointer (SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA, diff --git a/libsoup/soup-auth-domain-digest.c b/libsoup/soup-auth-domain-digest.c index cca944f7..f3345a94 100644 --- a/libsoup/soup-auth-domain-digest.c +++ b/libsoup/soup-auth-domain-digest.c @@ -96,12 +96,24 @@ soup_auth_domain_digest_class_init (SoupAuthDomainDigestClass *digest_class) object_class->set_property = set_property; object_class->get_property = get_property; + /** + * SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK: + * + * Alias for the #SoupAuthDomainDigest:auth-callback property. + * (The #SoupAuthDomainDigestAuthCallback.) + **/ g_object_class_install_property ( object_class, PROP_AUTH_CALLBACK, g_param_spec_pointer (SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK, "Authentication callback", "Password-finding callback", G_PARAM_READWRITE)); + /** + * SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA: + * + * Alias for the #SoupAuthDomainDigest:auth-callback property. + * (The #SoupAuthDomainDigestAuthCallback.) + **/ g_object_class_install_property ( object_class, PROP_AUTH_DATA, g_param_spec_pointer (SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA, diff --git a/libsoup/soup-auth-domain.c b/libsoup/soup-auth-domain.c index 049f838b..c34447c2 100644 --- a/libsoup/soup-auth-domain.c +++ b/libsoup/soup-auth-domain.c @@ -112,6 +112,12 @@ soup_auth_domain_class_init (SoupAuthDomainClass *auth_domain_class) object_class->set_property = set_property; object_class->get_property = get_property; + /** + * SOUP_AUTH_DOMAIN_REALM: + * + * Alias for the #SoupAuthDomain:realm property. (The realm of + * this auth domain.) + **/ g_object_class_install_property ( object_class, PROP_REALM, g_param_spec_string (SOUP_AUTH_DOMAIN_REALM, @@ -119,6 +125,12 @@ soup_auth_domain_class_init (SoupAuthDomainClass *auth_domain_class) "The realm of this auth domain", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_AUTH_DOMAIN_PROXY: + * + * Alias for the #SoupAuthDomain:proxy property. (Whether or + * not this is a proxy auth domain.) + **/ g_object_class_install_property ( object_class, PROP_PROXY, g_param_spec_boolean (SOUP_AUTH_DOMAIN_PROXY, @@ -126,6 +138,12 @@ soup_auth_domain_class_init (SoupAuthDomainClass *auth_domain_class) "Whether or not this is a proxy auth domain", FALSE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_AUTH_DOMAIN_ADD_PATH: + * + * Alias for the #SoupAuthDomain:add-path property. (Shortcut + * for calling soup_auth_domain_add_path().) + **/ g_object_class_install_property ( object_class, PROP_ADD_PATH, g_param_spec_string (SOUP_AUTH_DOMAIN_ADD_PATH, @@ -133,6 +151,12 @@ soup_auth_domain_class_init (SoupAuthDomainClass *auth_domain_class) "Add a path covered by this auth domain", NULL, G_PARAM_WRITABLE)); + /** + * SOUP_AUTH_DOMAIN_REMOVE_PATH: + * + * Alias for the #SoupAuthDomain:remove-path property. + * (Shortcut for calling soup_auth_domain_remove_path().) + **/ g_object_class_install_property ( object_class, PROP_REMOVE_PATH, g_param_spec_string (SOUP_AUTH_DOMAIN_REMOVE_PATH, @@ -140,24 +164,48 @@ soup_auth_domain_class_init (SoupAuthDomainClass *auth_domain_class) "Remove a path covered by this auth domain", NULL, G_PARAM_WRITABLE)); + /** + * SOUP_AUTH_DOMAIN_FILTER: + * + * Alias for the #SoupAuthDomain:filter property. (The + * #SoupAuthDomainFilter for the domain.) + **/ g_object_class_install_property ( object_class, PROP_FILTER, g_param_spec_pointer (SOUP_AUTH_DOMAIN_FILTER, "Filter", "A filter for deciding whether or not to require authentication", G_PARAM_READWRITE)); + /** + * SOUP_AUTH_DOMAIN_FILTER_DATA: + * + * Alias for the #SoupAuthDomain:filter-data property. (Data + * to pass to the #SoupAuthDomainFilter.) + **/ g_object_class_install_property ( object_class, PROP_FILTER_DATA, g_param_spec_pointer (SOUP_AUTH_DOMAIN_FILTER_DATA, "Filter data", "Data to pass to filter", G_PARAM_READWRITE)); + /** + * SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK: + * + * Alias for the #SoupAuthDomain:auth-callback property. + * (The #SoupAuthDomainGenericAuthCallback.) + **/ g_object_class_install_property ( object_class, PROP_GENERIC_AUTH_CALLBACK, g_param_spec_pointer (SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK, "Generic authentication callback", "An authentication callback that can be used with any SoupAuthDomain subclass", G_PARAM_READWRITE)); + /** + * SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA: + * + * Alias for the #SoupAuthDomain:auth-data property. + * (The data to pass to the #SoupAuthDomainGenericAuthCallback.) + **/ g_object_class_install_property ( object_class, PROP_GENERIC_AUTH_DATA, g_param_spec_pointer (SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA, diff --git a/libsoup/soup-auth.c b/libsoup/soup-auth.c index 221438f7..d77fd82d 100644 --- a/libsoup/soup-auth.c +++ b/libsoup/soup-auth.c @@ -86,6 +86,12 @@ soup_auth_class_init (SoupAuthClass *auth_class) object_class->get_property = get_property; /* properties */ + /** + * SOUP_AUTH_SCHEME_NAME: + * + * An alias for the #SoupAuth:scheme property. (The + * authentication scheme name.) + **/ g_object_class_install_property ( object_class, PROP_SCHEME_NAME, g_param_spec_string (SOUP_AUTH_SCHEME_NAME, @@ -93,6 +99,12 @@ soup_auth_class_init (SoupAuthClass *auth_class) "Authentication scheme name", NULL, G_PARAM_READABLE)); + /** + * SOUP_AUTH_REALM: + * + * An alias for the #SoupAuth:realm property. (The + * authentication realm.) + **/ g_object_class_install_property ( object_class, PROP_REALM, g_param_spec_string (SOUP_AUTH_REALM, @@ -100,6 +112,12 @@ soup_auth_class_init (SoupAuthClass *auth_class) "Authentication realm", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_AUTH_HOST: + * + * An alias for the #SoupAuth:host property. (The + * host being authenticated to.) + **/ g_object_class_install_property ( object_class, PROP_HOST, g_param_spec_string (SOUP_AUTH_HOST, @@ -107,6 +125,12 @@ soup_auth_class_init (SoupAuthClass *auth_class) "Authentication host", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_AUTH_IS_FOR_PROXY: + * + * An alias for the #SoupAuth:is-for-proxy property. (Whether + * or not the auth is for a proxy server.) + **/ g_object_class_install_property ( object_class, PROP_IS_FOR_PROXY, g_param_spec_boolean (SOUP_AUTH_IS_FOR_PROXY, @@ -114,6 +138,12 @@ soup_auth_class_init (SoupAuthClass *auth_class) "Whether or not the auth is for a proxy server", FALSE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_AUTH_IS_AUTHENTICATED: + * + * An alias for the #SoupAuth:is-authenticated property. + * (Whether or not the auth has been authenticated.) + **/ g_object_class_install_property ( object_class, PROP_IS_AUTHENTICATED, g_param_spec_boolean (SOUP_AUTH_IS_AUTHENTICATED, diff --git a/libsoup/soup-cookie-jar-sqlite.c b/libsoup/soup-cookie-jar-sqlite.c index 19471565..19d1827b 100644 --- a/libsoup/soup-cookie-jar-sqlite.c +++ b/libsoup/soup-cookie-jar-sqlite.c @@ -85,6 +85,12 @@ soup_cookie_jar_sqlite_class_init (SoupCookieJarSqliteClass *sqlite_class) object_class->set_property = set_property; object_class->get_property = get_property; + /** + * SOUP_COOKIE_JAR_SQLITE_FILENAME: + * + * Alias for the #SoupCookieJarSqlite:filename property. (The + * cookie-storage filename.) + **/ g_object_class_install_property ( object_class, PROP_FILENAME, g_param_spec_string (SOUP_COOKIE_JAR_SQLITE_FILENAME, @@ -144,6 +150,8 @@ get_property (GObject *object, guint prop_id, * jar is destroyed.) * * Return value: the new #SoupCookieJar + * + * Since: 2.26 **/ SoupCookieJar * soup_cookie_jar_sqlite_new (const char *filename, gboolean read_only) diff --git a/libsoup/soup-cookie-jar-text.c b/libsoup/soup-cookie-jar-text.c index a1d62eaf..bdae4274 100644 --- a/libsoup/soup-cookie-jar-text.c +++ b/libsoup/soup-cookie-jar-text.c @@ -82,6 +82,12 @@ soup_cookie_jar_text_class_init (SoupCookieJarTextClass *text_class) object_class->set_property = set_property; object_class->get_property = get_property; + /** + * SOUP_COOKIE_JAR_TEXT_FILENAME: + * + * Alias for the #SoupCookieJarText:filename property. (The + * cookie-storage filename.) + **/ g_object_class_install_property ( object_class, PROP_FILENAME, g_param_spec_string (SOUP_COOKIE_JAR_TEXT_FILENAME, @@ -141,6 +147,8 @@ get_property (GObject *object, guint prop_id, * jar is destroyed.) * * Return value: the new #SoupCookieJar + * + * Since: 2.26 **/ SoupCookieJar * soup_cookie_jar_text_new (const char *filename, gboolean read_only) diff --git a/libsoup/soup-cookie-jar.c b/libsoup/soup-cookie-jar.c index f536ebc3..bb0dca56 100644 --- a/libsoup/soup-cookie-jar.c +++ b/libsoup/soup-cookie-jar.c @@ -141,6 +141,12 @@ soup_cookie_jar_class_init (SoupCookieJarClass *jar_class) SOUP_TYPE_COOKIE | G_SIGNAL_TYPE_STATIC_SCOPE, SOUP_TYPE_COOKIE | G_SIGNAL_TYPE_STATIC_SCOPE); + /** + * SOUP_COOKIE_JAR_READ_ONLY: + * + * Alias for the #SoupCookieJar:read-only property. (Whether + * or not the cookie jar is read-only.) + **/ g_object_class_install_property ( object_class, PROP_READ_ONLY, g_param_spec_boolean (SOUP_COOKIE_JAR_READ_ONLY, @@ -200,6 +206,8 @@ get_property (GObject *object, guint prop_id, * not support persistent storage of cookies; use a subclass for that. * * Returns: a new #SoupCookieJar + * + * Since: 2.24 **/ SoupCookieJar * soup_cookie_jar_new (void) @@ -245,6 +253,8 @@ soup_cookie_jar_changed (SoupCookieJar *jar, * * Return value: the cookies, in string form, or %NULL if there are no * cookies for @uri. + * + * Since: 2.24 **/ char * soup_cookie_jar_get_cookies (SoupCookieJar *jar, SoupURI *uri, @@ -318,6 +328,8 @@ soup_cookie_jar_get_cookies (SoupCookieJar *jar, SoupURI *uri, * that the cookie's expire date is not in the past). * * @cookie will be 'stolen' by the jar, so don't free it afterwards. + * + * Since: 2.24 **/ void soup_cookie_jar_add_cookie (SoupCookieJar *jar, SoupCookie *cookie) @@ -383,6 +395,8 @@ soup_cookie_jar_add_cookie (SoupCookieJar *jar, SoupCookie *cookie) * * Adds @cookie to @jar, exactly as though it had appeared in a * Set-Cookie header returned from a request to @uri. + * + * Since: 2.24 **/ void soup_cookie_jar_set_cookie (SoupCookieJar *jar, SoupURI *uri, @@ -454,6 +468,8 @@ request_unqueued (SoupSessionFeature *feature, SoupSession *session, * you have to free them when you are done with them. * * Return value: a #GSList with all the cookies in the @jar. + * + * Since: 2.24 **/ GSList * soup_cookie_jar_all_cookies (SoupCookieJar *jar) @@ -484,6 +500,8 @@ soup_cookie_jar_all_cookies (SoupCookieJar *jar) * @cookie: a #SoupCookie * * Deletes @cookie from @jar, emitting the 'changed' signal. + * + * Since: 2.24 **/ void soup_cookie_jar_delete_cookie (SoupCookieJar *jar, diff --git a/libsoup/soup-cookie.c b/libsoup/soup-cookie.c index 2a61cc59..6f50d689 100644 --- a/libsoup/soup-cookie.c +++ b/libsoup/soup-cookie.c @@ -70,6 +70,8 @@ * If @http_only is set, the cookie should not be exposed to untrusted * code (eg, javascript), so as to minimize the danger posed by * cross-site scripting attacks. + * + * Since: 2.24 **/ /* Our Set-Cookie grammar is something like the following, in terms of @@ -144,6 +146,8 @@ soup_cookie_get_type (void) * Copies @cookie. * * Return value: a copy of @cookie + * + * Since: 2.24 **/ SoupCookie * soup_cookie_copy (SoupCookie *cookie) @@ -416,6 +420,8 @@ parse_one_cookie (const char **header_p, SoupURI *origin) * soup_cookie_set_expires().) * * Return value: a new #SoupCookie. + * + * Since: 2.24 **/ SoupCookie * soup_cookie_new (const char *name, const char *value, @@ -452,6 +458,8 @@ soup_cookie_new (const char *name, const char *value, * Return value: a new #SoupCookie, or %NULL if it could not be * parsed, or contained an illegal "domain" attribute for a cookie * originating from @origin. + * + * Since: 2.24 **/ SoupCookie * soup_cookie_parse (const char *cookie, SoupURI *origin) @@ -465,6 +473,8 @@ soup_cookie_parse (const char *cookie, SoupURI *origin) * @name: the new name * * Sets @cookie's name to @name + * + * Since: 2.24 **/ void soup_cookie_set_name (SoupCookie *cookie, const char *name) @@ -479,6 +489,8 @@ soup_cookie_set_name (SoupCookie *cookie, const char *name) * @value: the new value * * Sets @cookie's value to @value + * + * Since: 2.24 **/ void soup_cookie_set_value (SoupCookie *cookie, const char *value) @@ -493,6 +505,8 @@ soup_cookie_set_value (SoupCookie *cookie, const char *value) * @domain: the new domain * * Sets @cookie's domain to @domain + * + * Since: 2.24 **/ void soup_cookie_set_domain (SoupCookie *cookie, const char *domain) @@ -507,6 +521,8 @@ soup_cookie_set_domain (SoupCookie *cookie, const char *domain) * @path: the new path * * Sets @cookie's path to @path + * + * Since: 2.24 **/ void soup_cookie_set_path (SoupCookie *cookie, const char *path) @@ -530,6 +546,8 @@ soup_cookie_set_path (SoupCookie *cookie, const char *path) * considered already-expired.) * * (This sets the same property as soup_cookie_set_expires().) + * + * Since: 2.24 **/ void soup_cookie_set_max_age (SoupCookie *cookie, int max_age) @@ -553,24 +571,32 @@ soup_cookie_set_max_age (SoupCookie *cookie, int max_age) * * A constant corresponding to 1 hour, for use with soup_cookie_new() * and soup_cookie_set_max_age(). + * + * Since: 2.24 **/ /** * SOUP_COOKIE_MAX_AGE_ONE_DAY: * * A constant corresponding to 1 day, for use with soup_cookie_new() * and soup_cookie_set_max_age(). + * + * Since: 2.24 **/ /** * SOUP_COOKIE_MAX_AGE_ONE_WEEK: * * A constant corresponding to 1 week, for use with soup_cookie_new() * and soup_cookie_set_max_age(). + * + * Since: 2.24 **/ /** * SOUP_COOKIE_MAX_AGE_ONE_YEAR: * * A constant corresponding to 1 year, for use with soup_cookie_new() * and soup_cookie_set_max_age(). + * + * Since: 2.24 **/ /** @@ -583,6 +609,8 @@ soup_cookie_set_max_age (SoupCookie *cookie, int max_age) * client's session. * * (This sets the same property as soup_cookie_set_max_age().) + * + * Since: 2.24 **/ void soup_cookie_set_expires (SoupCookie *cookie, SoupDate *expires) @@ -604,6 +632,8 @@ soup_cookie_set_expires (SoupCookie *cookie, SoupDate *expires) * Sets @cookie's secure attribute to @secure. If %TRUE, @cookie will * only be transmitted from the client to the server over secure * (https) connections. + * + * Since: 2.24 **/ void soup_cookie_set_secure (SoupCookie *cookie, gboolean secure) @@ -619,6 +649,8 @@ soup_cookie_set_secure (SoupCookie *cookie, gboolean secure) * Sets @cookie's HttpOnly attribute to @http_only. If %TRUE, @cookie * will be marked as "http only", meaning it should not be exposed to * web page scripts or other untrusted code. + * + * Since: 2.24 **/ void soup_cookie_set_http_only (SoupCookie *cookie, gboolean http_only) @@ -673,6 +705,8 @@ serialize_cookie (SoupCookie *cookie, GString *header, gboolean set_cookie) * (ie, for sending a cookie from a #SoupServer to a client). * * Return value: the header + * + * Since: 2.24 **/ char * soup_cookie_to_set_cookie_header (SoupCookie *cookie) @@ -691,6 +725,8 @@ soup_cookie_to_set_cookie_header (SoupCookie *cookie) * returning a cookie from a #SoupSession to a server). * * Return value: the header + * + * Since: 2.24 **/ char * soup_cookie_to_cookie_header (SoupCookie *cookie) @@ -706,6 +742,8 @@ soup_cookie_to_cookie_header (SoupCookie *cookie) * @cookie: a #SoupCookie * * Frees @cookie + * + * Since: 2.24 **/ void soup_cookie_free (SoupCookie *cookie) @@ -733,6 +771,8 @@ soup_cookie_free (SoupCookie *cookie) * * Return value: a #GSList of #SoupCookie<!-- -->s, which can be freed * with soup_cookies_free(). + * + * Since: 2.24 **/ GSList * soup_cookies_from_response (SoupMessage *msg) @@ -777,6 +817,8 @@ soup_cookies_from_response (SoupMessage *msg) * * Return value: a #GSList of #SoupCookie<!-- -->s, which can be freed * with soup_cookies_free(). + * + * Since: 2.24 **/ GSList * soup_cookies_from_request (SoupMessage *msg) @@ -806,6 +848,8 @@ soup_cookies_from_request (SoupMessage *msg) * Appends a "Set-Cookie" response header to @msg for each cookie in * @cookies. (This is in addition to any other "Set-Cookie" headers * @msg may already have.) + * + * Since: 2.24 **/ void soup_cookies_to_response (GSList *cookies, SoupMessage *msg) @@ -833,6 +877,8 @@ soup_cookies_to_response (GSList *cookies, SoupMessage *msg) * these cookies will be appended to the cookies already present. Be * careful that you do not append the same cookies twice, eg, when * requeuing a message.) + * + * Since: 2.24 **/ void soup_cookies_to_request (GSList *cookies, SoupMessage *msg) @@ -855,6 +901,8 @@ soup_cookies_to_request (GSList *cookies, SoupMessage *msg) * @cookies: a #GSList of #SoupCookie * * Frees @cookies. + * + * Since: 2.24 **/ void soup_cookies_free (GSList *cookies) @@ -874,6 +922,8 @@ soup_cookies_free (GSList *cookies) * setting as the value of the "Cookie" header. * * Return value: the serialization of @cookies + * + * Since: 2.24 **/ char * soup_cookies_to_cookie_header (GSList *cookies) @@ -904,6 +954,8 @@ soup_cookies_to_cookie_header (GSList *cookies) * * Return value: %TRUE if @cookie should be sent to @uri, %FALSE if * not + * + * Since: 2.24 **/ gboolean soup_cookie_applies_to_uri (SoupCookie *cookie, SoupURI *uri) diff --git a/libsoup/soup-date.c b/libsoup/soup-date.c index 88a67615..cf1b9159 100644 --- a/libsoup/soup-date.c +++ b/libsoup/soup-date.c @@ -580,6 +580,8 @@ soup_date_to_time_t (SoupDate *date) * @time: a #GTimeVal structure in which to store the converted time. * * Converts @date to a #GTimeVal. + * + * Since: 2.24 */ void soup_date_to_timeval (SoupDate *date, GTimeVal *time) @@ -601,6 +603,8 @@ soup_date_to_timeval (SoupDate *date, GTimeVal *time) * Determines if @date is in the past. * * Return value: %TRUE if @date is in the past + * + * Since: 2.24 **/ gboolean soup_date_is_past (SoupDate *date) diff --git a/libsoup/soup-form.c b/libsoup/soup-form.c index 1bcc603a..a2103f78 100644 --- a/libsoup/soup-form.c +++ b/libsoup/soup-form.c @@ -32,6 +32,8 @@ * A macro containing the value * <literal>"application/x-www-form-urlencoded"</literal>; the default * MIME type for POSTing HTML form data. + * + * Since: 2.26 **/ /** @@ -40,6 +42,8 @@ * A macro containing the value * <literal>"multipart/form-data"</literal>; the MIME type used for * posting form data that contains files to be uploaded. + * + * Since: 2.26 **/ #define XDIGIT(c) ((c) <= '9' ? (c) - '0' : ((c) & 0x4F) - 'A' + 10) @@ -138,6 +142,8 @@ soup_form_decode (const char *encoded_form) * Return value: a hash table containing the name/value pairs (other * than @file_control_name) from @msg, which you can free with * g_hash_table_destroy(). On error, it will return %NULL. + * + * Since: 2.26 **/ GHashTable * soup_form_decode_multipart (SoupMessage *msg, const char *file_control_name, @@ -462,6 +468,8 @@ soup_form_request_new_from_datalist (const char *method, const char *uri, * structure and create a #SoupMessage. * * Return value: the new %SoupMessage + * + * Since: 2.26 **/ SoupMessage * soup_form_request_new_from_multipart (const char *uri, diff --git a/libsoup/soup-gnome-features.c b/libsoup/soup-gnome-features.c index 3d562c04..2a85e8c9 100644 --- a/libsoup/soup-gnome-features.c +++ b/libsoup/soup-gnome-features.c @@ -24,6 +24,8 @@ * This feature is included in %SOUP_TYPE_GNOME_FEATURES_2_26, so if * you are using that feature, you do not need to include this feature * separately. + * + * Since: 2.26 **/ GType soup_proxy_resolver_gnome_get_type (void) @@ -41,6 +43,8 @@ soup_proxy_resolver_gnome_get_type (void) * You can add this to a session using * soup_session_add_feature_by_type() or by using the * %SOUP_SESSION_ADD_FEATURE_BY_TIME construct-time property. + * + * Since: 2.26 **/ GType soup_gnome_features_2_26_get_type (void) diff --git a/libsoup/soup-headers.c b/libsoup/soup-headers.c index 9dcc162e..697163b4 100644 --- a/libsoup/soup-headers.c +++ b/libsoup/soup-headers.c @@ -29,6 +29,8 @@ * soup_headers_parse_request() or soup_headers_parse_response(). * * Return value: success or failure + * + * Since: 2.26 **/ gboolean soup_headers_parse (const char *str, int len, SoupMessageHeaders *dest) @@ -730,6 +732,8 @@ soup_header_parse_param_list (const char *header) * * Return value: a #GHashTable of list elements, which can be freed * with soup_header_free_param_list(). + * + * Since: 2.24 **/ GHashTable * soup_header_parse_semi_param_list (const char *header) @@ -793,6 +797,8 @@ append_param_quoted (GString *string, const char *value) * to work anywhere in HTTP that uses this style of parameter, in * reality, it can only be used portably with the Content-Disposition * "filename" parameter. + * + * Since: 2.26 **/ void soup_header_g_string_append_param (GString *string, const char *name, diff --git a/libsoup/soup-message-body.c b/libsoup/soup-message-body.c index c95f84d5..f3e75f74 100644 --- a/libsoup/soup-message-body.c +++ b/libsoup/soup-message-body.c @@ -353,6 +353,8 @@ soup_message_body_new (void) * In either case, @body's %data field will not be filled in after the * body is fully sent/received, since the body data will no longer be * available + * + * Since: 2.4.1 **/ void soup_message_body_set_accumulate (SoupMessageBody *body, @@ -371,6 +373,8 @@ soup_message_body_set_accumulate (SoupMessageBody *body, * soup_message_body_set_accumulate() for details. * * Return value: the accumulate flag for @body. + * + * Since: 2.4.1 **/ gboolean soup_message_body_get_accumulate (SoupMessageBody *body) @@ -578,6 +582,8 @@ soup_message_body_get_chunk (SoupMessageBody *body, goffset offset) * * This is a low-level method which you should not normally need to * use. + * + * Since: 2.4.1 **/ void soup_message_body_got_chunk (SoupMessageBody *body, SoupBuffer *chunk) @@ -603,6 +609,8 @@ soup_message_body_got_chunk (SoupMessageBody *body, SoupBuffer *chunk) * This is a low-level method which you should not need to use, and * there are further restrictions on its proper use which are not * documented here. + * + * Since: 2.4.1 **/ void soup_message_body_wrote_chunk (SoupMessageBody *body, SoupBuffer *chunk) diff --git a/libsoup/soup-message-headers.c b/libsoup/soup-message-headers.c index a8652eaf..c1570c5f 100644 --- a/libsoup/soup-message-headers.c +++ b/libsoup/soup-message-headers.c @@ -695,6 +695,8 @@ soup_message_headers_set_expectations (SoupMessageHeaders *hdrs, * If @end is %-1 and @start is negative, then it represents a "suffix * range", referring to the last -@start bytes of the resource body. * (Eg, the last 500 bytes would be @start = %-500 and @end = %-1.) + * + * Since: 2.26 **/ static int @@ -727,6 +729,8 @@ sort_ranges (gconstpointer a, gconstpointer b) * Return value: %TRUE if @hdrs contained a "Range" header containing * byte ranges which could be parsed, %FALSE otherwise (in which case * @range and @length will not be set). + * + * Since: 2.26 **/ gboolean soup_message_headers_get_ranges (SoupMessageHeaders *hdrs, @@ -809,6 +813,8 @@ soup_message_headers_get_ranges (SoupMessageHeaders *hdrs, * @ranges: an array of #SoupRange * * Frees the array of ranges returned from soup_message_headers_get_ranges(). + * + * Since: 2.26 **/ void soup_message_headers_free_ranges (SoupMessageHeaders *hdrs, @@ -826,6 +832,8 @@ soup_message_headers_free_ranges (SoupMessageHeaders *hdrs, * Sets @hdrs's Range header to request the indicated ranges. (If you * only want to request a single range, you can use * soup_message_headers_set_range().) + * + * Since: 2.26 **/ void soup_message_headers_set_ranges (SoupMessageHeaders *hdrs, @@ -866,6 +874,8 @@ soup_message_headers_set_ranges (SoupMessageHeaders *hdrs, * * If you need to request multiple ranges, use * soup_message_headers_set_ranges(). + * + * Since: 2.26 **/ void soup_message_headers_set_range (SoupMessageHeaders *hdrs, @@ -893,6 +903,8 @@ soup_message_headers_set_range (SoupMessageHeaders *hdrs, * * Return value: %TRUE if @hdrs contained a "Content-Range" header * containing a byte range which could be parsed, %FALSE otherwise. + * + * Since: 2.26 **/ gboolean soup_message_headers_get_content_range (SoupMessageHeaders *hdrs, @@ -941,6 +953,8 @@ soup_message_headers_get_content_range (SoupMessageHeaders *hdrs, * Sets @hdrs's Content-Range header according to the given values. * (Note that @total_length is the total length of the entire resource * that this is a range of, not simply @end - @start + 1.) + * + * Since: 2.26 **/ void soup_message_headers_set_content_range (SoupMessageHeaders *hdrs, @@ -1046,6 +1060,8 @@ content_type_setter (SoupMessageHeaders *hdrs, const char *value) * Return value: a string with the value of the "Content-Type" header * or NULL if @hdrs does not contain that header (in which case * *@params will be * unchanged, is it has been given). + * + * Since: 2.26 **/ const char * soup_message_headers_get_content_type (SoupMessageHeaders *hdrs, @@ -1067,6 +1083,8 @@ soup_message_headers_get_content_type (SoupMessageHeaders *hdrs, * * Sets the "Content-Type" header in @hdrs to @content_type, * optionally with additional parameters specified in @params. + * + * Since: 2.26 **/ void soup_message_headers_set_content_type (SoupMessageHeaders *hdrs, @@ -1103,6 +1121,8 @@ soup_message_headers_set_content_type (SoupMessageHeaders *hdrs, * Return value: %TRUE if @hdrs contains a "Content-Disposition" * header, %FALSE if not (in which case *@disposition and *@params * will be unchanged). + * + * Since: 2.26 **/ gboolean soup_message_headers_get_content_disposition (SoupMessageHeaders *hdrs, @@ -1139,6 +1159,8 @@ soup_message_headers_get_content_disposition (SoupMessageHeaders *hdrs, * * See soup_message_headers_get_content_disposition() for a discussion * of how Content-Disposition is used in HTTP. + * + * Since: 2.26 **/ void soup_message_headers_set_content_disposition (SoupMessageHeaders *hdrs, diff --git a/libsoup/soup-message.c b/libsoup/soup-message.c index dbdc89a0..c7df0d36 100644 --- a/libsoup/soup-message.c +++ b/libsoup/soup-message.c @@ -250,6 +250,8 @@ soup_message_class_init (SoupMessageClass *message_class) * Unlike #SoupMessage::wrote_chunk, this is emitted after * every successful write() call, not only after finishing a * complete "chunk". + * + * Since: 2.4.1 **/ signals[WROTE_BODY_DATA] = g_signal_new ("wrote_body_data", @@ -424,6 +426,12 @@ soup_message_class_init (SoupMessageClass *message_class) G_TYPE_NONE, 0); /* properties */ + /** + * SOUP_MESSAGE_METHOD: + * + * Alias for the #SoupMessage:method property. (The message's + * HTTP method.) + **/ g_object_class_install_property ( object_class, PROP_METHOD, g_param_spec_string (SOUP_MESSAGE_METHOD, @@ -431,6 +439,12 @@ soup_message_class_init (SoupMessageClass *message_class) "The message's HTTP method", SOUP_METHOD_GET, G_PARAM_READWRITE)); + /** + * SOUP_MESSAGE_URI: + * + * Alias for the #SoupMessage:uri property. (The message's + * #SoupURI.) + **/ g_object_class_install_property ( object_class, PROP_URI, g_param_spec_boxed (SOUP_MESSAGE_URI, @@ -438,6 +452,12 @@ soup_message_class_init (SoupMessageClass *message_class) "The message's Request-URI", SOUP_TYPE_URI, G_PARAM_READWRITE)); + /** + * SOUP_MESSAGE_HTTP_VERSION: + * + * Alias for the #SoupMessage:http-version property. (The + * message's #SoupHTTPVersion.) + **/ g_object_class_install_property ( object_class, PROP_HTTP_VERSION, g_param_spec_enum (SOUP_MESSAGE_HTTP_VERSION, @@ -446,6 +466,12 @@ soup_message_class_init (SoupMessageClass *message_class) SOUP_TYPE_HTTP_VERSION, SOUP_HTTP_1_1, G_PARAM_READWRITE)); + /** + * SOUP_MESSAGE_FLAGS: + * + * Alias for the #SoupMessage:flags property. (The message's + * #SoupMessageFlags.) + **/ g_object_class_install_property ( object_class, PROP_FLAGS, g_param_spec_flags (SOUP_MESSAGE_FLAGS, @@ -454,6 +480,12 @@ soup_message_class_init (SoupMessageClass *message_class) SOUP_TYPE_MESSAGE_FLAGS, 0, G_PARAM_READWRITE)); + /** + * SOUP_MESSAGE_SERVER_SIDE: + * + * Alias for the #SoupMessage:server-side property. (%TRUE if + * the message was created by #SoupServer.) + **/ g_object_class_install_property ( object_class, PROP_SERVER_SIDE, g_param_spec_boolean (SOUP_MESSAGE_SERVER_SIDE, @@ -461,6 +493,12 @@ soup_message_class_init (SoupMessageClass *message_class) "Whether or not the message is server-side rather than client-side", FALSE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_MESSAGE_STATUS_CODE: + * + * Alias for the #SoupMessage:status-code property. (The + * message's HTTP response status code.) + **/ g_object_class_install_property ( object_class, PROP_STATUS_CODE, g_param_spec_uint (SOUP_MESSAGE_STATUS_CODE, @@ -468,6 +506,12 @@ soup_message_class_init (SoupMessageClass *message_class) "The HTTP response status code", 0, 599, 0, G_PARAM_READWRITE)); + /** + * SOUP_MESSAGE_REASON_PHRASE: + * + * Alias for the #SoupMessage:reason-phrase property. (The + * message's HTTP response reason phrase.) + **/ g_object_class_install_property ( object_class, PROP_REASON_PHRASE, g_param_spec_string (SOUP_MESSAGE_REASON_PHRASE, @@ -1325,6 +1369,8 @@ soup_message_get_uri (SoupMessage *msg) * session will resolve it before sending the message. * * Return value: the address @msg's URI points to + * + * Since: 2.26 **/ SoupAddress * soup_message_get_address (SoupMessage *msg) diff --git a/libsoup/soup-method.c b/libsoup/soup-method.c index 539c4646..cae311fa 100644 --- a/libsoup/soup-method.c +++ b/libsoup/soup-method.c @@ -29,3 +29,79 @@ const char *_SOUP_METHOD_PROPPATCH = NULL; const char *_SOUP_METHOD_PUT = NULL; const char *_SOUP_METHOD_TRACE = NULL; const char *_SOUP_METHOD_UNLOCK = NULL; + +/** + * SOUP_METHOD_OPTIONS: + * + * "OPTIONS" as an interned string. + **/ +/** + * SOUP_METHOD_GET: + * + * "GET" as an interned string. + **/ +/** + * SOUP_METHOD_HEAD: + * + * "HEAD" as an interned string. + **/ +/** + * SOUP_METHOD_POST: + * + * "POST" as an interned string. + **/ +/** + * SOUP_METHOD_PUT: + * + * "PUT" as an interned string. + **/ +/** + * SOUP_METHOD_DELETE: + * + * "DELETE" as an interned string. + **/ +/** + * SOUP_METHOD_TRACE: + * + * "TRACE" as an interned string. + **/ +/** + * SOUP_METHOD_CONNECT: + * + * "CONNECT" as an interned string. + **/ +/** + * SOUP_METHOD_PROPFIND: + * + * "PROPFIND" as an interned string. + **/ +/** + * SOUP_METHOD_PROPPATCH: + * + * "PROPPATCH" as an interned string. + **/ +/** + * SOUP_METHOD_MKCOL: + * + * "MKCOL" as an interned string. + **/ +/** + * SOUP_METHOD_COPY: + * + * "COPY" as an interned string. + **/ +/** + * SOUP_METHOD_MOVE: + * + * "MOVE" as an interned string. + **/ +/** + * SOUP_METHOD_LOCK: + * + * "LOCK" as an interned string. + **/ +/** + * SOUP_METHOD_UNLOCK: + * + * "UNLOCK" as an interned string. + **/ diff --git a/libsoup/soup-misc.c b/libsoup/soup-misc.c index 575dfaab..d67345b2 100644 --- a/libsoup/soup-misc.c +++ b/libsoup/soup-misc.c @@ -181,6 +181,8 @@ soup_add_idle (GMainContext *async_context, * * Return value: a #GSource, which can be removed from @async_context * with g_source_destroy(). + * + * Since: 2.24 **/ GSource * soup_add_completion (GMainContext *async_context, diff --git a/libsoup/soup-multipart.c b/libsoup/soup-multipart.c index 33b94e85..50b35492 100644 --- a/libsoup/soup-multipart.c +++ b/libsoup/soup-multipart.c @@ -31,6 +31,8 @@ * have "binary" Content-Transfer-Encoding, even if its headers * explicitly state otherwise. In other words, don't try to use * #SoupMultipart for handling real MIME multiparts. + * + * Since: 2.26 **/ struct SoupMultipart { @@ -85,6 +87,8 @@ generate_boundary (void) * including "multipart/". * * Return value: a new empty #SoupMultipart of the given @mime_type + * + * Since: 2.26 **/ SoupMultipart * soup_multipart_new (const char *mime_type) @@ -120,6 +124,8 @@ find_boundary (const char *start, const char *boundary, int boundary_len) * * Return value: a new #SoupMultipart (or %NULL if the message couldn't * be parsed or wasn't multipart). + * + * Since: 2.26 **/ SoupMultipart * soup_multipart_new_from_message (SoupMessageHeaders *headers, @@ -214,6 +220,8 @@ soup_multipart_new_from_message (SoupMessageHeaders *headers, * Gets the number of body parts in @multipart * * Return value: the number of body parts in @multipart + * + * Since: 2.26 **/ int soup_multipart_get_length (SoupMultipart *multipart) @@ -232,6 +240,8 @@ soup_multipart_get_length (SoupMultipart *multipart) * * Return value: %TRUE on success, %FALSE if @part is out of range (in * which case @headers and @body won't be set) + * + * Since: 2.26 **/ gboolean soup_multipart_get_part (SoupMultipart *multipart, int part, @@ -254,6 +264,8 @@ soup_multipart_get_part (SoupMultipart *multipart, int part, * (The multipart will make its own copies of @headers and @body, so * you should free your copies if you are not using them for anything * else.) + * + * Since: 2.26 **/ void soup_multipart_append_part (SoupMultipart *multipart, @@ -304,6 +316,8 @@ soup_multipart_append_part (SoupMultipart *multipart, * "Content-Disposition: form-data", as per the HTML forms * specification. See soup_form_request_new_from_multipart() for more * details. + * + * Since: 2.26 **/ void soup_multipart_append_form_string (SoupMultipart *multipart, @@ -329,6 +343,8 @@ soup_multipart_append_form_string (SoupMultipart *multipart, * "Content-Disposition: form-data", as per the HTML forms * specification. See soup_form_request_new_from_multipart() for more * details. + * + * Since: 2.26 **/ void soup_multipart_append_form_file (SoupMultipart *multipart, @@ -379,6 +395,8 @@ soup_multipart_append_form_file (SoupMultipart *multipart, * @dest_body: the body of the HTTP message to serialize @multipart to * * Serializes @multipart to @dest_headers and @dest_body. + * + * Since: 2.26 **/ void soup_multipart_to_message (SoupMultipart *multipart, @@ -436,6 +454,8 @@ soup_multipart_to_message (SoupMultipart *multipart, * @multipart: a #SoupMultipart * * Frees @multipart + * + * Since: 2.26 **/ void soup_multipart_free (SoupMultipart *multipart) diff --git a/libsoup/soup-nossl.c b/libsoup/soup-nossl.c index 70088c77..744049c0 100644 --- a/libsoup/soup-nossl.c +++ b/libsoup/soup-nossl.c @@ -51,8 +51,15 @@ soup_ssl_free_server_credentials (SoupSSLCredentials *server_creds) #endif /* ! HAVE_SSL */ /** + * SOUP_SSL_ERROR: + * + * A #GError domain representing an SSL error. Used with #SoupSSLError. + **/ +/** * soup_ssl_error_quark: * + * The quark used as %SOUP_SSL_ERROR + * * Return value: The quark used as %SOUP_SSL_ERROR **/ GQuark @@ -63,3 +70,15 @@ soup_ssl_error_quark (void) error = g_quark_from_static_string ("soup_ssl_error_quark"); return error; } + +/** + * SoupSSLError: + * @SOUP_SSL_ERROR_HANDSHAKE_NEEDS_READ: Internal error. Never exposed + * outside of libsoup. + * @SOUP_SSL_ERROR_HANDSHAKE_NEEDS_WRITE: Internal error. Never exposed + * outside of libsoup. + * @SOUP_SSL_ERROR_CERTIFICATE: Indicates an error validating an SSL + * certificate + * + * SSL-related I/O errors. + **/ diff --git a/libsoup/soup-proxy-resolver.c b/libsoup/soup-proxy-resolver.c index 3085ff77..630c10c1 100644 --- a/libsoup/soup-proxy-resolver.c +++ b/libsoup/soup-proxy-resolver.c @@ -44,6 +44,8 @@ soup_proxy_resolver_get_type (void) * * Asynchronously determines a proxy server address to use for @msg * and calls @callback. + * + * Since: 2.26 **/ void soup_proxy_resolver_get_proxy_async (SoupProxyResolver *proxy_resolver, @@ -72,6 +74,8 @@ soup_proxy_resolver_get_proxy_async (SoupProxyResolver *proxy_resolver, * * Return value: SOUP_STATUS_OK if successful, or a transport-level * error. + * + * Since: 2.26 **/ guint soup_proxy_resolver_get_proxy_sync (SoupProxyResolver *proxy_resolver, diff --git a/libsoup/soup-server.c b/libsoup/soup-server.c index bb12b3f4..e34fffbb 100644 --- a/libsoup/soup-server.c +++ b/libsoup/soup-server.c @@ -314,6 +314,12 @@ soup_server_class_init (SoupServerClass *server_class) SOUP_TYPE_CLIENT_CONTEXT); /* properties */ + /** + * SOUP_SERVER_PORT: + * + * Alias for the #SoupServer:port property. (The port the + * server listens on.) + **/ g_object_class_install_property ( object_class, PROP_PORT, g_param_spec_uint (SOUP_SERVER_PORT, @@ -321,6 +327,12 @@ soup_server_class_init (SoupServerClass *server_class) "Port to listen on", 0, 65536, 0, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_SERVER_INTERFACE: + * + * Alias for the #SoupServer:interface property. (The address + * of the network interface the server listens on.) + **/ g_object_class_install_property ( object_class, PROP_INTERFACE, g_param_spec_object (SOUP_SERVER_INTERFACE, @@ -328,6 +340,12 @@ soup_server_class_init (SoupServerClass *server_class) "Address of interface to listen on", SOUP_TYPE_ADDRESS, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_SERVER_SSL_CERT_FILE: + * + * Alias for the #SoupServer:ssl-cert-file property. (The file + * containing the SSL certificate for the server.) + **/ g_object_class_install_property ( object_class, PROP_SSL_CERT_FILE, g_param_spec_string (SOUP_SERVER_SSL_CERT_FILE, @@ -335,6 +353,12 @@ soup_server_class_init (SoupServerClass *server_class) "File containing server SSL certificate", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_SERVER_SSL_KEY_FILE: + * + * Alias for the #SoupServer:ssl-key-file property. (The file + * containing the SSL certificate key for the server.) + **/ g_object_class_install_property ( object_class, PROP_SSL_KEY_FILE, g_param_spec_string (SOUP_SERVER_SSL_KEY_FILE, @@ -342,12 +366,25 @@ soup_server_class_init (SoupServerClass *server_class) "File containing server SSL key", NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_SERVER_ASYNC_CONTEXT: + * + * Alias for the #SoupServer:async-context property. (The + * server's #GMainContext.) + **/ g_object_class_install_property ( object_class, PROP_ASYNC_CONTEXT, g_param_spec_pointer (SOUP_SERVER_ASYNC_CONTEXT, "Async GMainContext", "The GMainContext to dispatch async I/O in", G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_SERVER_RAW_PATHS: + * + * Alias for the #SoupServer:raw-paths property. (If %TRUE, + * percent-encoding in the Request-URI path will not be + * automatically decoded.) + **/ g_object_class_install_property ( object_class, PROP_RAW_PATHS, g_param_spec_boolean (SOUP_SERVER_RAW_PATHS, @@ -384,6 +421,11 @@ soup_server_class_init (SoupServerClass *server_class) * "<literal>libsoup/2.3.2</literal>") to the end of the * header for you. **/ + /** + * SOUP_SERVER_SERVER_HEADER: + * + * Alias for the #SoupServer:server-header property, qv. + **/ g_object_class_install_property ( object_class, PROP_SERVER_HEADER, g_param_spec_string (SOUP_SERVER_SERVER_HEADER, diff --git a/libsoup/soup-session-feature.c b/libsoup/soup-session-feature.c index df774b9e..3f1ff775 100644 --- a/libsoup/soup-session-feature.c +++ b/libsoup/soup-session-feature.c @@ -29,6 +29,8 @@ * * An object that implement some sort of optional feature for * #SoupSession. + * + * Since: 2.24 **/ /** @@ -41,6 +43,8 @@ * @request_unqueued: Proxies the session's #SoupSession::request_unqueued signal * * The interface implemented by #SoupSessionFeature<!-- -->s. + * + * Since: 2.24 **/ static void soup_session_feature_interface_init (SoupSessionFeatureInterface *interface); diff --git a/libsoup/soup-session.c b/libsoup/soup-session.c index 2ea721cf..c5e00067 100644 --- a/libsoup/soup-session.c +++ b/libsoup/soup-session.c @@ -293,6 +293,8 @@ soup_session_class_init (SoupSessionClass *session_class) * exactly once, but #SoupSession::request_started and * #SoupMessage::finished (and all of the other #SoupMessage * signals) may be invoked multiple times for a given message. + * + * Since: 2.4.1 **/ signals[REQUEST_QUEUED] = g_signal_new ("request-queued", @@ -334,6 +336,8 @@ soup_session_class_init (SoupSessionClass *session_class) * indicating that @session is done with it. See * #SoupSession::request_queued for a detailed description of the * message lifecycle within a session. + * + * Since: 2.4.1 **/ signals[REQUEST_UNQUEUED] = g_signal_new ("request-unqueued", @@ -381,6 +385,12 @@ soup_session_class_init (SoupSessionClass *session_class) G_TYPE_BOOLEAN); /* properties */ + /** + * SOUP_SESSION_PROXY_URI: + * + * Alias for the #SoupSession:proxy-uri property. (The HTTP + * proxy to use for this session.) + **/ g_object_class_install_property ( object_class, PROP_PROXY_URI, g_param_spec_boxed (SOUP_SESSION_PROXY_URI, @@ -388,6 +398,12 @@ soup_session_class_init (SoupSessionClass *session_class) "The HTTP Proxy to use for this session", SOUP_TYPE_URI, G_PARAM_READWRITE)); + /** + * SOUP_SESSION_MAX_CONNS: + * + * Alias for the #SoupSession:max-conns property. (The maximum + * number of connections that the session can open at once.) + **/ g_object_class_install_property ( object_class, PROP_MAX_CONNS, g_param_spec_int (SOUP_SESSION_MAX_CONNS, @@ -397,6 +413,13 @@ soup_session_class_init (SoupSessionClass *session_class) G_MAXINT, SOUP_SESSION_MAX_CONNS_DEFAULT, G_PARAM_READWRITE)); + /** + * SOUP_SESSION_MAX_CONNS_PER_HOST: + * + * Alias for the #SoupSession:max-conns-per-host property. + * (The maximum number of connections that the session can + * open at once to a given host.) + **/ g_object_class_install_property ( object_class, PROP_MAX_CONNS_PER_HOST, g_param_spec_int (SOUP_SESSION_MAX_CONNS_PER_HOST, @@ -406,6 +429,21 @@ soup_session_class_init (SoupSessionClass *session_class) G_MAXINT, SOUP_SESSION_MAX_CONNS_PER_HOST_DEFAULT, G_PARAM_READWRITE)); + /** + * SoupSession:idle-timeout: + * + * Connection lifetime when idle + * + * Since: 2.4.1 + **/ + /** + * SOUP_SESSION_IDLE_TIMEOUT: + * + * Alias for the #SoupSession:idle-timeout property. (The idle + * connection lifetime.) + * + * Since: 2.4.1 + **/ g_object_class_install_property ( object_class, PROP_IDLE_TIMEOUT, g_param_spec_uint (SOUP_SESSION_IDLE_TIMEOUT, @@ -413,6 +451,12 @@ soup_session_class_init (SoupSessionClass *session_class) "Connection lifetime when idle", 0, G_MAXUINT, 0, G_PARAM_READWRITE)); + /** + * SOUP_SESSION_USE_NTLM: + * + * Alias for the #SoupSession:use-ntlm property. (Whether or + * not to use NTLM authentication.) + **/ g_object_class_install_property ( object_class, PROP_USE_NTLM, g_param_spec_boolean (SOUP_SESSION_USE_NTLM, @@ -420,6 +464,12 @@ soup_session_class_init (SoupSessionClass *session_class) "Whether or not to use NTLM authentication", FALSE, G_PARAM_READWRITE)); + /** + * SOUP_SESSION_SSL_CA_FILE: + * + * Alias for the #SoupSession:ssl-ca-file property. (File + * containing SSL CA certificates.) + **/ g_object_class_install_property ( object_class, PROP_SSL_CA_FILE, g_param_spec_string (SOUP_SESSION_SSL_CA_FILE, @@ -427,12 +477,24 @@ soup_session_class_init (SoupSessionClass *session_class) "File containing SSL CA certificates", NULL, G_PARAM_READWRITE)); + /** + * SOUP_SESSION_ASYNC_CONTEXT: + * + * Alias for the #SoupSession:async-context property. (The + * session's #GMainContext.) + **/ g_object_class_install_property ( object_class, PROP_ASYNC_CONTEXT, g_param_spec_pointer (SOUP_SESSION_ASYNC_CONTEXT, "Async GMainContext", "The GMainContext to dispatch async I/O in", G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_SESSION_TIMEOUT: + * + * Alias for the #SoupSession:timeout property. (The timeout + * in seconds for blocking socket I/O operations.) + **/ g_object_class_install_property ( object_class, PROP_TIMEOUT, g_param_spec_uint (SOUP_SESSION_TIMEOUT, @@ -468,6 +530,11 @@ soup_session_class_init (SoupSessionClass *session_class) * (eg, "<literal>libsoup/2.3.2</literal>") to the end of the * header for you. **/ + /** + * SOUP_SESSION_USER_AGENT: + * + * Alias for the #SoupSession:user-agent property, qv. + **/ g_object_class_install_property ( object_class, PROP_USER_AGENT, g_param_spec_string (SOUP_SESSION_USER_AGENT, @@ -476,6 +543,22 @@ soup_session_class_init (SoupSessionClass *session_class) NULL, G_PARAM_READWRITE)); + /** + * SoupSession:add-feature: + * + * Add a feature object to the session. (Shortcut for calling + * soup_session_add_feature().) + * + * Since: 2.24 + **/ + /** + * SOUP_SESSION_ADD_FEATURE: + * + * Alias for the #SoupSession:add-feature property. (Shortcut + * for calling soup_session_add_feature(). + * + * Since: 2.24 + **/ g_object_class_install_property ( object_class, PROP_ADD_FEATURE, g_param_spec_object (SOUP_SESSION_ADD_FEATURE, @@ -483,6 +566,22 @@ soup_session_class_init (SoupSessionClass *session_class) "Add a feature object to the session", SOUP_TYPE_SESSION_FEATURE, G_PARAM_READWRITE)); + /** + * SoupSession:add-feature-by-type: + * + * Add a feature object of the given type to the session. + * (Shortcut for calling soup_session_add_feature_by_type().) + * + * Since: 2.24 + **/ + /** + * SOUP_SESSION_ADD_FEATURE_BY_TYPE: + * + * Alias for the #SoupSession:add-feature-by-type property. + * (Shortcut for calling soup_session_add_feature_by_type(). + * + * Since: 2.24 + **/ g_object_class_install_property ( object_class, PROP_ADD_FEATURE_BY_TYPE, g_param_spec_gtype (SOUP_SESSION_ADD_FEATURE_BY_TYPE, @@ -490,6 +589,23 @@ soup_session_class_init (SoupSessionClass *session_class) "Add a feature object of the given type to the session", SOUP_TYPE_SESSION_FEATURE, G_PARAM_READWRITE)); + /** + * SoupSession:remove-feature-by-type: + * + * Remove feature objects from the session. (Shortcut for + * calling soup_session_remove_feature_by_type().) + * + * Since: 2.24 + **/ + /** + * SOUP_SESSION_REMOVE_FEATURE_BY_TYPE: + * + * Alias for the #SoupSession:remove-feature-by-type + * property. (Shortcut for calling + * soup_session_remove_feature_by_type(). + * + * Since: 2.24 + **/ g_object_class_install_property ( object_class, PROP_REMOVE_FEATURE_BY_TYPE, g_param_spec_gtype (SOUP_SESSION_REMOVE_FEATURE_BY_TYPE, @@ -1342,6 +1458,8 @@ soup_session_abort (SoupSession *session) * Adds @feature's functionality to @session. You can also add a * feature to the session at construct time by using the * %SOUP_SESSION_ADD_FEATURE property. + * + * Since: 2.24 **/ void soup_session_add_feature (SoupSession *session, SoupSessionFeature *feature) @@ -1369,6 +1487,8 @@ soup_session_add_feature (SoupSession *session, SoupSessionFeature *feature) * the case wher you don't need to customize the new feature in any * way. You can also add a feature to the session at construct time by * using the %SOUP_SESSION_ADD_FEATURE_BY_TYPE property. + * + * Since: 2.24 **/ void soup_session_add_feature_by_type (SoupSession *session, GType feature_type) @@ -1389,6 +1509,8 @@ soup_session_add_feature_by_type (SoupSession *session, GType feature_type) * @feature: a feature that has previously been added to @session * * Removes @feature's functionality from @session. + * + * Since: 2.24 **/ void soup_session_remove_feature (SoupSession *session, SoupSessionFeature *feature) @@ -1417,6 +1539,8 @@ soup_session_remove_feature (SoupSession *session, SoupSessionFeature *feature) * @feature_type) from @session. You can also remove standard features * from the session at construct time by using the * %SOUP_SESSION_REMOVE_FEATURE_BY_TYPE property. + * + * Since: 2.24 **/ void soup_session_remove_feature_by_type (SoupSession *session, GType feature_type) @@ -1447,6 +1571,8 @@ restart: * * Return value: a list of features. You must free the list, but not * its contents + * + * Since: 2.26 **/ GSList * soup_session_get_features (SoupSession *session, GType feature_type) @@ -1475,6 +1601,8 @@ soup_session_get_features (SoupSession *session, GType feature_type) * * Return value: a #SoupSessionFeature, or %NULL. The feature is owned * by @session. + * + * Since: 2.26 **/ SoupSessionFeature * soup_session_get_feature (SoupSession *session, GType feature_type) diff --git a/libsoup/soup-socket.c b/libsoup/soup-socket.c index 1e05ee68..f7b1a5c9 100644 --- a/libsoup/soup-socket.c +++ b/libsoup/soup-socket.c @@ -247,6 +247,12 @@ soup_socket_class_init (SoupSocketClass *socket_class) SOUP_TYPE_SOCKET); /* properties */ + /** + * SOUP_SOCKET_LOCAL_ADDRESS: + * + * Alias for the #SoupSocket:local-address property. (Address + * of local end of socket.) + **/ g_object_class_install_property ( object_class, PROP_LOCAL_ADDRESS, g_param_spec_object (SOUP_SOCKET_LOCAL_ADDRESS, @@ -254,6 +260,12 @@ soup_socket_class_init (SoupSocketClass *socket_class) "Address of local end of socket", SOUP_TYPE_ADDRESS, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_SOCKET_REMOTE_ADDRESS: + * + * Alias for the #SoupSocket:remote-address property. (Address + * of remote end of socket.) + **/ g_object_class_install_property ( object_class, PROP_REMOTE_ADDRESS, g_param_spec_object (SOUP_SOCKET_REMOTE_ADDRESS, @@ -285,6 +297,12 @@ soup_socket_class_init (SoupSocketClass *socket_class) * simply never return %SOUP_SOCKET_WOULD_BLOCK, and so the * code that handles that case just won't get used for them. **/ + /** + * SOUP_SOCKET_FLAG_NONBLOCKING: + * + * Alias for the #SoupSocket:non-blocking property. (Whether + * or not the socket uses non-blocking I/O.) + **/ g_object_class_install_property ( object_class, PROP_NON_BLOCKING, g_param_spec_boolean (SOUP_SOCKET_FLAG_NONBLOCKING, @@ -292,6 +310,12 @@ soup_socket_class_init (SoupSocketClass *socket_class) "Whether or not the socket uses non-blocking I/O", TRUE, G_PARAM_READWRITE)); + /** + * SOUP_SOCKET_IS_SERVER: + * + * Alias for the #SoupSocket:is-server property. (Whether or + * not the socket is a server socket.) + **/ g_object_class_install_property ( object_class, PROP_IS_SERVER, g_param_spec_boolean (SOUP_SOCKET_IS_SERVER, @@ -299,12 +323,24 @@ soup_socket_class_init (SoupSocketClass *socket_class) "Whether or not the socket is a server socket", FALSE, G_PARAM_READABLE)); + /** + * SOUP_SOCKET_SSL_CREDENTIALS: + * + * Alias for the #SoupSocket:ssl-credentials property. + * (SSL credential information.) + **/ g_object_class_install_property ( object_class, PROP_SSL_CREDENTIALS, g_param_spec_pointer (SOUP_SOCKET_SSL_CREDENTIALS, "SSL credentials", "SSL credential information, passed from the session to the SSL implementation", G_PARAM_READWRITE)); + /** + * SOUP_SOCKET_ASYNC_CONTEXT: + * + * Alias for the #SoupSocket:async-context property. (The + * socket's #GMainContext.) + **/ g_object_class_install_property ( object_class, PROP_ASYNC_CONTEXT, g_param_spec_pointer (SOUP_SOCKET_ASYNC_CONTEXT, @@ -312,6 +348,12 @@ soup_socket_class_init (SoupSocketClass *socket_class) "The GMainContext to dispatch this socket's async I/O in", G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY)); + /** + * SOUP_SOCKET_TIMEOUT: + * + * Alias for the #SoupSocket:timeout property. (The timeout + * in seconds for blocking socket I/O operations.) + **/ g_object_class_install_property ( object_class, PROP_TIMEOUT, g_param_spec_uint (SOUP_SOCKET_TIMEOUT, diff --git a/libsoup/soup-status.c b/libsoup/soup-status.c index c8527f72..668bd7bd 100644 --- a/libsoup/soup-status.c +++ b/libsoup/soup-status.c @@ -148,6 +148,14 @@ * network and internal errors. **/ +/** + * SOUP_HTTP_ERROR: + * + * A #GError domain representing an HTTP status. Use a + * #SoupKnownStatusCode for the <structfield>code</structfield> + * value. + **/ + static const struct { guint code; const char *phrase; @@ -257,6 +265,8 @@ soup_status_get_phrase (guint status_code) * Other status codes are passed through unchanged. * * Return value: the "proxified" equivalent of @status_code. + * + * Since: 2.26 **/ guint soup_status_proxify (guint status_code) diff --git a/libsoup/soup-uri.c b/libsoup/soup-uri.c index cf29582f..ff923adb 100644 --- a/libsoup/soup-uri.c +++ b/libsoup/soup-uri.c @@ -87,6 +87,8 @@ * it can be used to construct a #SoupMessage. * * Return value: %TRUE if @uri is a valid "http" or "https" URI. + * + * Since: 2.24 **/ static void append_uri_encoded (GString *str, const char *in, const char *extra_enc_chars); |