GNOME.org
 

[libsoup] Add/update some "Since" flags

commit 96bbe5d54fecc86b12055b0f48166c993c602f6f
Author: Dan Winship <danw gnome org>
Date:   Sun Jul 31 13:55:57 2011 -0400

    Add/update some "Since" flags

 libsoup/soup-address.c                |    2 +
 libsoup/soup-cache.c                  |   28 +++++++++++++++--------
 libsoup/soup-cookie-jar.c             |   14 ++++++++++-
 libsoup/soup-headers.c                |    2 +-
 libsoup/soup-message-headers.c        |    3 +-
 libsoup/soup-message.c                |   30 +++++++++++++++++++++++++-
 libsoup/soup-proxy-resolver-default.c |    9 +++++++
 libsoup/soup-request-http.c           |    4 ++-
 libsoup/soup-request.c                |    6 ++--
 libsoup/soup-session-feature.c        |   38 +++++++++++++++++++++++++++++++++
 libsoup/soup-session.c                |    4 +++
 11 files changed, 121 insertions(+), 19 deletions(-)
---
diff --git a/libsoup/soup-address.c b/libsoup/soup-address.c
index 0904687..fa625e1 100644
--- a/libsoup/soup-address.c
+++ b/libsoup/soup-address.c
@@ -479,6 +479,8 @@ soup_address_get_sockaddr (SoupAddress *addr, int *len)
  * to only have one socket address associated with it).
  *
  * Return value: (transfer full): a new #GSocketAddress
+ *
+ * Since: 2.32
  */
 GSocketAddress *
 soup_address_get_gsockaddr (SoupAddress *addr)
diff --git a/libsoup/soup-cache.c b/libsoup/soup-cache.c
index ad0419f..652ec66 100644
--- a/libsoup/soup-cache.c
+++ b/libsoup/soup-cache.c
@@ -548,7 +548,7 @@ close_ready_cb (GObject *source, GAsyncResult *result, SoupCacheWritingFixture *
 		entry = NULL;
 	} else if ((soup_message_headers_get_encoding (entry->headers) == SOUP_ENCODING_CHUNKED) ||
 		   entry->length != (gsize) content_length) {
-		/** Two options here:
+		/* Two options here:
 		 *
 		 * 1. "chunked" data, entry was temporarily added to
 		 * cache (as content-length is 0) and now that we have
@@ -560,7 +560,7 @@ close_ready_cb (GObject *source, GAsyncResult *result, SoupCacheWritingFixture *
 		 * transmission (typically compressed) and thus we
 		 * have to substract the content-length value that was
 		 * added to the cache and add the unencoded length
-		 **/
+		 */
 		gint length_to_add = entry->length - content_length;
 
 		/* Make room in cache if needed */
@@ -757,7 +757,7 @@ lru_compare_func (gconstpointer a, gconstpointer b)
 	SoupCacheEntry *entry_a = (SoupCacheEntry *)a;
 	SoupCacheEntry *entry_b = (SoupCacheEntry *)b;
 
-	/** The rationale of this sorting func is
+	/* The rationale of this sorting func is
 	 *
 	 * 1. sort by hits -> LRU algorithm, then
 	 *
@@ -766,7 +766,7 @@ lru_compare_func (gconstpointer a, gconstpointer b)
 	 *
 	 * 3. sort by size, replace first small size resources as they
 	 * are cheaper to download
-	 **/
+	 */
 
 	/* Sort by hits */
 	if (entry_a->hits != entry_b->hits)
@@ -1258,8 +1258,8 @@ soup_cache_class_init (SoupCacheClass *cache_class)
  *
  * Returns: a new #SoupCache
  *
- * Since: 2.28
- **/
+ * Since: 2.34
+ */
 SoupCache *
 soup_cache_new (const char *cache_dir, SoupCacheType cache_type)
 {
@@ -1279,7 +1279,9 @@ soup_cache_new (const char *cache_dir, SoupCacheType cache_type)
  * and the cached reply and the time ellapsed since it was cached.
  *
  * Returns: whether or not the @cache has a valid response for @msg
- **/
+ *
+ * Since: 2.34
+ */
 SoupCacheResponse
 soup_cache_has_response (SoupCache *cache, SoupMessage *msg)
 {
@@ -1430,7 +1432,9 @@ soup_cache_has_response (SoupCache *cache, SoupMessage *msg)
  * Calculates whether the @msg can be cached or not.
  *
  * Returns: a #SoupCacheability value indicating whether the @msg can be cached or not.
- **/
+ *
+ * Since: 2.34
+ */
 SoupCacheability
 soup_cache_get_cacheability (SoupCache *cache, SoupMessage *msg)
 {
@@ -1456,7 +1460,9 @@ force_flush_timeout (gpointer data)
  * This function will force all pending writes in the @cache to be
  * committed to disk. For doing so it will iterate the #GMainContext
  * associated with @cache's session as long as needed.
- **/
+ *
+ * Since: 2.34
+ */
 void
 soup_cache_flush (SoupCache *cache)
 {
@@ -1500,7 +1506,9 @@ clear_cache_item (gpointer data,
  *
  * Will remove all entries in the @cache plus all the cache files
  * associated with them.
- **/
+ *
+ * Since: 2.34
+ */
 void
 soup_cache_clear (SoupCache *cache)
 {
diff --git a/libsoup/soup-cookie-jar.c b/libsoup/soup-cookie-jar.c
index 88fe731..e429429 100644
--- a/libsoup/soup-cookie-jar.c
+++ b/libsoup/soup-cookie-jar.c
@@ -167,7 +167,16 @@ soup_cookie_jar_class_init (SoupCookieJarClass *jar_class)
 	 * SOUP_COOKIE_JAR_ACCEPT_POLICY:
 	 *
 	 * Alias for the #SoupCookieJar:accept-policy property.
-	 **/
+	 *
+	 * Since: 2.30
+	 */
+	/**
+	 * SoupCookieJar:accept-policy:
+	 *
+	 * The policy the jar should follow to accept or reject cookies
+	 *
+	 * Since: 2.30
+	 */
 	g_object_class_install_property (
 		object_class, PROP_ACCEPT_POLICY,
 		g_param_spec_enum (SOUP_COOKIE_JAR_ACCEPT_POLICY,
@@ -701,7 +710,8 @@ soup_cookie_jar_delete_cookie (SoupCookieJar *jar,
  * document. If no first party is set in a message when this policy is
  * in effect, cookies will be assumed to be third party by default.
  *
-**/
+ * Since: 2.30
+ */
 
 /**
  * soup_cookie_jar_get_accept_policy:
diff --git a/libsoup/soup-headers.c b/libsoup/soup-headers.c
index ba66e8d..37f60a9 100644
--- a/libsoup/soup-headers.c
+++ b/libsoup/soup-headers.c
@@ -894,7 +894,7 @@ append_param_internal (GString    *string,
  * If @value is (non-ASCII) UTF-8, this will instead use RFC 5987
  * encoding, just like soup_header_g_string_append_param().
  *
- * Since: 2.32
+ * Since: 2.30
  **/
 void
 soup_header_g_string_append_param_quoted (GString    *string,
diff --git a/libsoup/soup-message-headers.c b/libsoup/soup-message-headers.c
index 2f83add..a350304 100644
--- a/libsoup/soup-message-headers.c
+++ b/libsoup/soup-message-headers.c
@@ -146,7 +146,8 @@ soup_message_headers_clear (SoupMessageHeaders *hdrs)
  *
  * Removes all the headers listed in the Connection header.
  *
- **/
+ * Since: 2.36
+ */
 void
 soup_message_headers_clean_connection_headers (SoupMessageHeaders *hdrs)
 {
diff --git a/libsoup/soup-message.c b/libsoup/soup-message.c
index 29b279e..56f202f 100644
--- a/libsoup/soup-message.c
+++ b/libsoup/soup-message.c
@@ -589,7 +589,17 @@ soup_message_class_init (SoupMessageClass *message_class)
 	 * Alias for the #SoupMessage:first-party property. (The
 	 * #SoupURI loaded in the application when the message was
 	 * queued.)
+	 *
+	 * Since: 2.30
 	 **/
+	/**
+	 * SoupMessage:first-party:
+	 *
+	 * The #SoupURI loaded in the application when the message was
+	 * queued.
+	 *
+	 * Since: 2.30
+	 */
 	g_object_class_install_property (
 		object_class, PROP_FIRST_PARTY,
 		g_param_spec_boxed (SOUP_MESSAGE_FIRST_PARTY,
@@ -654,7 +664,16 @@ soup_message_class_init (SoupMessageClass *message_class)
 	 *
 	 * Alias for the #SoupMessage:tls-certificate property. (The
 	 * TLS certificate associated with the message, if any.)
+	 *
+	 * Since: 2.34
 	 **/
+	/**
+	 * SoupMessage:tls-certificate:
+	 *
+	 * The #GTlsCertificate associated with the message
+	 *
+	 * Since: 2.34
+	 */	 
 	g_object_class_install_property (
 		object_class, PROP_TLS_CERTIFICATE,
 		g_param_spec_object (SOUP_MESSAGE_TLS_CERTIFICATE,
@@ -667,7 +686,16 @@ soup_message_class_init (SoupMessageClass *message_class)
 	 *
 	 * Alias for the #SoupMessage:tls-errors property. (The
 	 * verification errors on #SoupMessage:tls-certificate.)
+	 *
+	 * Since: 2.34
 	 **/
+	/**
+	 * SoupMessage:tls-certificate:
+	 *
+	 * The verification errors on #SoupMessage:tls-certificate
+	 *
+	 * Since: 2.34
+	 */	 
 	g_object_class_install_property (
 		object_class, PROP_TLS_ERRORS,
 		g_param_spec_flags (SOUP_MESSAGE_TLS_ERRORS,
@@ -1792,7 +1820,7 @@ soup_message_disables_feature (SoupMessage *msg, gpointer feature)
  * 
  * Since: 2.30
  **/
-SoupURI*
+SoupURI *
 soup_message_get_first_party (SoupMessage *msg)
 {
 	SoupMessagePrivate *priv;
diff --git a/libsoup/soup-proxy-resolver-default.c b/libsoup/soup-proxy-resolver-default.c
index b7554a8..58be8ab 100644
--- a/libsoup/soup-proxy-resolver-default.c
+++ b/libsoup/soup-proxy-resolver-default.c
@@ -17,6 +17,15 @@
 #include "soup-session-feature.h"
 #include "soup-uri.h"
 
+/**
+ * SoupProxyResolverDefault:
+ *
+ * A #SoupProxyURIResolver implementation that uses the default gio
+ * #GProxyResolver to resolve proxies.
+ *
+ * Since: 2.34
+ */
+
 static void soup_proxy_resolver_default_interface_init (SoupProxyURIResolverInterface *proxy_resolver_interface);
 
 G_DEFINE_TYPE_EXTENDED (SoupProxyResolverDefault, soup_proxy_resolver_default, G_TYPE_OBJECT, 0,
diff --git a/libsoup/soup-request-http.c b/libsoup/soup-request-http.c
index 9cb5e4b..90a5c48 100644
--- a/libsoup/soup-request-http.c
+++ b/libsoup/soup-request-http.c
@@ -346,7 +346,9 @@ soup_request_http_class_init (SoupRequestHTTPClass *request_http_class)
  * Gets a new reference to the #SoupMessage associated to this SoupRequest
  *
  * Returns: a new reference to the #SoupMessage
- **/
+ *
+ * Since: 2.34
+ */
 SoupMessage *
 soup_request_http_get_message (SoupRequestHTTP *http)
 {
diff --git a/libsoup/soup-request.c b/libsoup/soup-request.c
index 1ba9550..ac85615 100644
--- a/libsoup/soup-request.c
+++ b/libsoup/soup-request.c
@@ -39,15 +39,15 @@
  * @short_description: Protocol-independent streaming request interface
  *
  * FIXME
- **/
+ */
 
 /**
  * SoupRequest:
  *
  * FIXME
  *
- * Since: 2.30
- **/
+ * Since: 2.34
+ */
 
 static void soup_request_initable_interface_init (GInitableIface *initable_interface);
 
diff --git a/libsoup/soup-session-feature.c b/libsoup/soup-session-feature.c
index 1db9c20..97061ad 100644
--- a/libsoup/soup-session-feature.c
+++ b/libsoup/soup-session-feature.c
@@ -165,6 +165,20 @@ soup_session_feature_detach (SoupSessionFeature *feature,
 	SOUP_SESSION_FEATURE_GET_CLASS (feature)->detach (feature, session);
 }
 
+/**
+ * soup_session_feature_add_feature:
+ * @feature: the "base" feature
+ * @type: the #GType of a "sub-feature"
+ *
+ * Adds a "sub-feature" of type @type to the base feature @feature.
+ * This is used for features that can be extended with multiple
+ * different types. Eg, the authentication manager can be extended
+ * with subtypes of #SoupAuth.
+ *
+ * Return value: %TRUE if @feature accepted @type as a subfeature.
+ *
+ * Since: 2.34
+ */
 gboolean
 soup_session_feature_add_feature (SoupSessionFeature *feature,
 				  GType               type)
@@ -178,6 +192,18 @@ soup_session_feature_add_feature (SoupSessionFeature *feature,
 		return FALSE;
 }
 
+/**
+ * soup_session_feature_remove_feature:
+ * @feature: the "base" feature
+ * @type: the #GType of a "sub-feature"
+ *
+ * Removes the "sub-feature" of type @type from the base feature
+ * @feature. See soup_session_feature_add_feature().
+ *
+ * Return value: %TRUE if @type was removed from @feature
+ *
+ * Since: 2.34
+ */
 gboolean
 soup_session_feature_remove_feature (SoupSessionFeature *feature,
 				     GType               type)
@@ -191,6 +217,18 @@ soup_session_feature_remove_feature (SoupSessionFeature *feature,
 		return FALSE;
 }
 
+/**
+ * soup_session_feature_has_feature:
+ * @feature: the "base" feature
+ * @type: the #GType of a "sub-feature"
+ *
+ * Tests if @feature has a "sub-feature" of type @type. See
+ * soup_session_feature_add_feature().
+ *
+ * Return value: %TRUE if @feature has a subfeature of type @type
+ *
+ * Since: 2.34
+ */
 gboolean
 soup_session_feature_has_feature (SoupSessionFeature *feature,
 				  GType               type)
diff --git a/libsoup/soup-session.c b/libsoup/soup-session.c
index 7e68689..4c947ce 100644
--- a/libsoup/soup-session.c
+++ b/libsoup/soup-session.c
@@ -624,6 +624,8 @@ soup_session_class_init (SoupSessionClass *session_class)
 	 * SOUP_SESSION_ACCEPT_LANGUAGE:
 	 *
 	 * Alias for the #SoupSession:accept-language property, qv.
+	 *
+	 * Since: 2.30
 	 **/
 	g_object_class_install_property (
 		object_class, PROP_ACCEPT_LANGUAGE,
@@ -649,6 +651,8 @@ soup_session_class_init (SoupSessionClass *session_class)
 	 * SOUP_SESSION_ACCEPT_LANGUAGE_AUTO:
 	 *
 	 * Alias for the #SoupSession:accept-language-auto property, qv.
+	 *
+	 * Since: 2.30
 	 **/
 	g_object_class_install_property (
 		object_class, PROP_ACCEPT_LANGUAGE_AUTO,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]