summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCorentin Noël <tintou@noel.tf>2022-12-05 19:08:01 +0100
committerCorentin Noël <tintou@noel.tf>2022-12-05 19:14:53 +0100
commitcb8ba67698876e63a193ecce0e4de3529f179bfb (patch)
tree3a7c6d7aa49f4ca191edebb5a77556568d707aef
parent5970778a89f33352b59da689cdb7d088555b1d53 (diff)
downloadlibrest-tintou/rest-extras-binding.tar.gz
rest-extras: Enhance the annotation coveragetintou/rest-extras-binding
-rw-r--r--rest-extras/flickr-proxy.c13
-rw-r--r--rest-extras/lastfm-proxy.c13
-rw-r--r--rest-extras/youtube-proxy.c7
3 files changed, 26 insertions, 7 deletions
diff --git a/rest-extras/flickr-proxy.c b/rest-extras/flickr-proxy.c
index 7e60fa1..322ffdf 100644
--- a/rest-extras/flickr-proxy.c
+++ b/rest-extras/flickr-proxy.c
@@ -251,8 +251,8 @@ flickr_proxy_get_shared_secret (FlickrProxy *self)
*
* Get the current token.
*
- * Returns: the token, or %NULL if there is no token yet. This string is owned
- * by #FlickrProxy and should not be freed.
+ * Returns: (nullable): the token, or %NULL if there is no token yet.
+ * This string is owned by #FlickrProxy and should not be freed.
*/
const char *
flickr_proxy_get_token (FlickrProxy *self)
@@ -289,6 +289,15 @@ flickr_proxy_set_token (FlickrProxy *self,
}
}
+/**
+ * flickr_proxy_sign:
+ * @proxy: an #FlickrProxy
+ * @params: (element-type utf8 utf8): the request parameters
+ *
+ * Get the md5 checksum of the request.
+ *
+ * Returns: The md5 checksum of the request
+ */
char *
flickr_proxy_sign (FlickrProxy *self,
GHashTable *params)
diff --git a/rest-extras/lastfm-proxy.c b/rest-extras/lastfm-proxy.c
index 7b0dd28..15d625d 100644
--- a/rest-extras/lastfm-proxy.c
+++ b/rest-extras/lastfm-proxy.c
@@ -242,8 +242,8 @@ lastfm_proxy_get_secret (LastfmProxy *self)
*
* Get the current session key.
*
- * Returns: the session key, or %NULL if there is no session key yet. This string is owned
- * by #LastfmProxy and should not be freed.
+ * Returns: (nullable): the session key, or %NULL if there is no session key yet.
+ * This string is owned by #LastfmProxy and should not be freed.
*/
const char *
lastfm_proxy_get_session_key (LastfmProxy *self)
@@ -278,6 +278,15 @@ lastfm_proxy_set_session_key (LastfmProxy *self,
priv->session_key = g_strdup (session_key);
}
+/**
+ * lastfm_proxy_sign:
+ * @proxy: an #LastfmProxy
+ * @params: (element-type utf8 utf8): the request parameters
+ *
+ * Get the md5 checksum of the request.
+ *
+ * Returns: The md5 checksum of the request
+ */
char *
lastfm_proxy_sign (LastfmProxy *self,
GHashTable *params)
diff --git a/rest-extras/youtube-proxy.c b/rest-extras/youtube-proxy.c
index 08faca4..fe43ea3 100644
--- a/rest-extras/youtube-proxy.c
+++ b/rest-extras/youtube-proxy.c
@@ -392,10 +392,11 @@ _message_wrote_data_cb (SoupMessage *msg,
* youtube_proxy_upload_async:
* @self: a #YoutubeProxy
* @filename: filename
- * @fields: fields
+ * @fields: (element-type utf8 utf8): fields
* @incomplete: incomplete
- * @callback: (scope async): callback to invoke upon completion
- * @weak_object: an object instance used to tie the life cycle of the proxy to
+ * @callback: (scope call): callback to invoke upon completion
+ * @weak_object: (nullable): an object instance used to tie the life cycle of
+ * the proxy to
* @user_data: user data to pass to the callback
* @error: a #GError pointer, or %NULL
*