diff options
| author | Dan Winship <danw@src.gnome.org> | 2009-03-08 15:05:43 +0000 |
|---|---|---|
| committer | Dan Winship <danw@src.gnome.org> | 2009-03-08 15:05:43 +0000 |
| commit | 777915733e447d61afd05e80555d900bb74e6dd2 (patch) | |
| tree | 76f9bfba7fbbf5d3ba933e0bf154f1f3f94ff6c0 /libsoup/soup-cookie-jar.c | |
| parent | ea5335e91e36d6897c729f26f66dbc7bdb7b6eb3 (diff) | |
| download | libsoup-777915733e447d61afd05e80555d900bb74e6dd2.tar.gz | |
gtk-doc updates. In particular, document a bunch of convenience #defines,
* libsoup/*.c: gtk-doc updates. In particular, document a bunch of
convenience #defines, and add "Since" tags where appropriate.
svn path=/trunk/; revision=1246
Diffstat (limited to 'libsoup/soup-cookie-jar.c')
| -rw-r--r-- | libsoup/soup-cookie-jar.c | 18 |
1 files changed, 18 insertions, 0 deletions
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, |