[librest] Fix annotations



commit 218f44c0daa866a54bc6dd16b6500fb8f9338b4b
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Wed Nov 20 13:08:59 2013 +0000

    Fix annotations
    
    Syntax matters.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=712747

 rest/rest-proxy-call.c |    4 ++--
 rest/rest-proxy.c      |    7 ++++---
 rest/rest-xml-node.c   |    6 +++---
 3 files changed, 9 insertions(+), 8 deletions(-)
---
diff --git a/rest/rest-proxy-call.c b/rest/rest-proxy-call.c
index 17121ac..a09629b 100644
--- a/rest/rest-proxy-call.c
+++ b/rest/rest-proxy-call.c
@@ -845,7 +845,7 @@ prepare_message (RestProxyCall *call, GError **error_out)
 }
 
 /**
- * rest_proxy_call_async: (skip):
+ * rest_proxy_call_async: (skip)
  * @call: The #RestProxyCall
  * @callback: a #RestProxyCallAsyncCallback to invoke on completion of the call
  * @weak_object: The #GObject to weakly reference and tie the lifecycle too
@@ -1248,7 +1248,7 @@ rest_proxy_call_upload (RestProxyCall                *call,
 }
 
 /**
- * rest_proxy_call_cancel: (skip):
+ * rest_proxy_call_cancel: (skip)
  * @call: The #RestProxyCall
  *
  * Cancel this call.  It may be too late to not actually send the message, but
diff --git a/rest/rest-proxy.c b/rest/rest-proxy.c
index ce52de1..44f56bf 100644
--- a/rest/rest-proxy.c
+++ b/rest/rest-proxy.c
@@ -382,20 +382,21 @@ rest_proxy_class_init (RestProxyClass *klass)
   /**
    * RestProxy::authenticate:
    * @proxy: the proxy
+   * @auth: authentication state
    * @retrying: %TRUE if this is the second (or later) attempt
    *
    * Emitted when the proxy requires authentication. If
    * credentials are available, set the 'username' and 'password'
-   * properties on @proxy and return TRUE from the callback.
+   * properties on @proxy and return %TRUE from the callback.
    * This will cause the signal emission to stop, and librest will
    * try to connect with these credentials
    * If these credentials fail, the signal will be
    * emitted again, with @retrying set to %TRUE, which will
-   * continue until FALSE is returned from the callback.
+   * continue until %FALSE is returned from the callback.
    *
    * If you call rest_proxy_auth_pause() on @auth before
    * returning, then you can the authentication credentials on
-   * the RestProxy object asynchronously. You have to make sure
+   * the #RestProxy object asynchronously. You have to make sure
    * that @auth does not get destroyed with g_object_ref().
    * You can then unpause the authentication with
    * rest_proxy_auth_unpause() when everything is ready for it
diff --git a/rest/rest-xml-node.c b/rest/rest-xml-node.c
index 4598ccd..042b7ad 100644
--- a/rest/rest-xml-node.c
+++ b/rest/rest-xml-node.c
@@ -135,7 +135,7 @@ _rest_xml_node_new ()
 }
 
 /**
- * rest_xml_node_ref: (skip):
+ * rest_xml_node_ref: (skip)
  * @node: a #RestXmlNode
  *
  * Increases the reference count of @node.
@@ -154,7 +154,7 @@ rest_xml_node_ref (RestXmlNode *node)
 }
 
 /**
- * rest_xml_node_unref: (skip):
+ * rest_xml_node_unref: (skip)
  * @node: a #RestXmlNode
  *
  * Decreases the reference count of @node. When its reference count drops to 0,
@@ -276,7 +276,7 @@ rest_xml_node_find (RestXmlNode *start,
  *
  * Recursively outputs given node and it's children.
  *
- * Return value: (transfer: full): xml string representing the node.
+ * Return value: (transfer full): xml string representing the node.
  */
 char *
 rest_xml_node_print (RestXmlNode *node)


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