[libsoup] Add/fix some annotations



commit e06d243fadb351b63ba6e7734fd1a9b9fccf4d50
Author: Dan Winship <danw gnome org>
Date:   Sat Jun 29 13:10:23 2013 -0400

    Add/fix some annotations

 libsoup/soup-auth.c             |    5 +++++
 libsoup/soup-message.c          |    2 +-
 libsoup/soup-password-manager.c |    4 ++++
 libsoup/soup-password-manager.h |   20 ++++++++++++--------
 libsoup/soup-requester.c        |   10 ++++++++++
 libsoup/soup-session.c          |    8 ++++----
 libsoup/soup-socket.h           |    8 ++++----
 libsoup/soup-uri.c              |   23 -----------------------
 8 files changed, 40 insertions(+), 40 deletions(-)
---
diff --git a/libsoup/soup-auth.c b/libsoup/soup-auth.c
index 0c348ad..7c34dcf 100644
--- a/libsoup/soup-auth.c
+++ b/libsoup/soup-auth.c
@@ -524,6 +524,11 @@ soup_auth_free_protection_space (SoupAuth *auth, GSList *space)
        g_slist_free_full (space, g_free);
 }
 
+/**
+ * soup_auth_get_saved_users:
+ *
+ * Return value: (transfer full) (element-type utf8):
+ */
 GSList *
 soup_auth_get_saved_users (SoupAuth *auth)
 {
diff --git a/libsoup/soup-message.c b/libsoup/soup-message.c
index cd206a2..d18eab1 100644
--- a/libsoup/soup-message.c
+++ b/libsoup/soup-message.c
@@ -1925,7 +1925,7 @@ soup_message_set_soup_request (SoupMessage *msg,
  * If @msg is associated with a #SoupRequest, this returns that
  * request. Otherwise it returns %NULL.
  *
- * Return value: @msg's associated #SoupRequest
+ * Return value: (transfer none): @msg's associated #SoupRequest
  *
  * Since: 2.42
  */
diff --git a/libsoup/soup-password-manager.c b/libsoup/soup-password-manager.c
index d9cf81c..532ff7e 100644
--- a/libsoup/soup-password-manager.c
+++ b/libsoup/soup-password-manager.c
@@ -21,6 +21,10 @@ soup_password_manager_default_init (SoupPasswordManagerInterface *iface)
 {
 }
 
+/**
+ * soup_password_manager_get_passwords_async:
+ * @callback: (scope async)
+ */
 void
 soup_password_manager_get_passwords_async (SoupPasswordManager  *password_manager,
                                           SoupMessage          *msg,
diff --git a/libsoup/soup-password-manager.h b/libsoup/soup-password-manager.h
index d4e60ac..aa5faf5 100644
--- a/libsoup/soup-password-manager.h
+++ b/libsoup/soup-password-manager.h
@@ -17,8 +17,8 @@
 
 typedef struct _SoupPasswordManager SoupPasswordManager;
 
-typedef void (*SoupPasswordManagerCallback) (SoupPasswordManager *,
-                                            SoupMessage *, SoupAuth *,
+typedef void (*SoupPasswordManagerCallback) (SoupPasswordManager *password_manager,
+                                            SoupMessage *msg, SoupAuth *auth,
                                             gboolean retrying,
                                             gpointer user_data);
 
@@ -26,12 +26,16 @@ typedef struct {
        GTypeInterface base;
 
        /* virtual methods */
-       void (*get_passwords_async) (SoupPasswordManager *, SoupMessage *,
-                                    SoupAuth *, gboolean,
-                                    GMainContext *, GCancellable *,
-                                    SoupPasswordManagerCallback, gpointer);
-       void (*get_passwords_sync)  (SoupPasswordManager *, SoupMessage *,
-                                    SoupAuth *, GCancellable *);
+       void (*get_passwords_async) (SoupPasswordManager *password_manager,
+                                    SoupMessage *msg, SoupAuth *auth,
+                                    gboolean retrying,
+                                    GMainContext *async_context,
+                                    GCancellable *cancellable,
+                                    SoupPasswordManagerCallback callback,
+                                    gpointer user_data);
+       void (*get_passwords_sync)  (SoupPasswordManager *password_manager,
+                                    SoupMessage *msg, SoupAuth *auth,
+                                    GCancellable *cancellable);
 
 } SoupPasswordManagerInterface;
 
diff --git a/libsoup/soup-requester.c b/libsoup/soup-requester.c
index 60648e1..c67bfe3 100644
--- a/libsoup/soup-requester.c
+++ b/libsoup/soup-requester.c
@@ -144,6 +144,11 @@ translate_error (GError *error)
                g_warn_if_reached ();
 }
 
+/**
+ * soup_requester_request:
+ *
+ * Return value: (transfer full):
+ */
 SoupRequest *
 soup_requester_request (SoupRequester *requester, const char *uri_string,
                        GError **error)
@@ -161,6 +166,11 @@ soup_requester_request (SoupRequester *requester, const char *uri_string,
        return NULL;
 }
 
+/**
+ * soup_requester_request_uri:
+ *
+ * Return value: (transfer full):
+ */
 SoupRequest *
 soup_requester_request_uri (SoupRequester *requester, SoupURI *uri,
                            GError **error)
diff --git a/libsoup/soup-session.c b/libsoup/soup-session.c
index 7ffd8f7..abdebef 100644
--- a/libsoup/soup-session.c
+++ b/libsoup/soup-session.c
@@ -4056,8 +4056,8 @@ soup_session_send_async (SoupSession         *session,
  * successful), returns a #GInputStream that can be used to read the
  * response body.
  *
- * Return value: a #GInputStream for reading the response body, or
- *   %NULL on error.
+ * Return value: (transfer full): a #GInputStream for reading the
+ *   response body, or %NULL on error.
  *
  * Since: 2.42
  */
@@ -4121,8 +4121,8 @@ soup_session_send_finish (SoupSession   *session,
  * (Note that this method cannot be called on the deprecated
  * #SoupSessionAsync subclass.)
  *
- * Return value: a #GInputStream for reading the response body, or
- *   %NULL on error.
+ * Return value: (transfer full): a #GInputStream for reading the
+ *   response body, or %NULL on error.
  *
  * Since: 2.42
  */
diff --git a/libsoup/soup-socket.h b/libsoup/soup-socket.h
index ed405bd..5c1264f 100644
--- a/libsoup/soup-socket.h
+++ b/libsoup/soup-socket.h
@@ -26,11 +26,11 @@ typedef struct {
        GObjectClass parent_class;
 
        /* signals */
-       void (*readable)       (SoupSocket *);
-       void (*writable)       (SoupSocket *);
-       void (*disconnected)   (SoupSocket *);
+       void (*readable)       (SoupSocket *sock);
+       void (*writable)       (SoupSocket *sock);
+       void (*disconnected)   (SoupSocket *sock);
 
-       void (*new_connection) (SoupSocket *, SoupSocket *);
+       void (*new_connection) (SoupSocket *listener, SoupSocket *new_sock);
 
        /* Padding for future expansion */
        void (*_libsoup_reserved1) (void);
diff --git a/libsoup/soup-uri.c b/libsoup/soup-uri.c
index 26ec24a..b9ff93f 100644
--- a/libsoup/soup-uri.c
+++ b/libsoup/soup-uri.c
@@ -864,29 +864,6 @@ soup_uri_uses_default_port (SoupURI *uri)
 }
 
 /**
- * SOUP_URI_SCHEME_HTTP:
- *
- * "http" as an interned string. This can be compared directly against
- * the value of a #SoupURI's <structfield>scheme</structfield>
- **/
-
-/**
- * SOUP_URI_SCHEME_HTTPS:
- *
- * "https" as an interned string. This can be compared directly
- * against the value of a #SoupURI's <structfield>scheme</structfield>
- **/
-
-/**
- * SOUP_URI_SCHEME_RESOURCE:
- *
- * "resource" as an interned string. This can be compared directly
- * against the value of a #SoupURI's <structfield>scheme</structfield>
- *
- * Since: 2.42
- **/
-
-/**
  * soup_uri_get_scheme:
  * @uri: a #SoupURI
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]