[librest/wip/baedert/tests: 5/22] RestProxy: Document set/get_user_agent



commit e37927a14b82cd11ebc9d58b4d328f82274426de
Author: Timm Bäder <mail baedert org>
Date:   Fri Jul 22 09:04:43 2016 +0200

    RestProxy: Document set/get_user_agent

 rest/rest-proxy.c |   15 +++++++++++++++
 1 files changed, 15 insertions(+), 0 deletions(-)
---
diff --git a/rest/rest-proxy.c b/rest/rest-proxy.c
index 80972a3..e14654a 100644
--- a/rest/rest-proxy.c
+++ b/rest/rest-proxy.c
@@ -512,6 +512,13 @@ rest_proxy_bind (RestProxy *proxy, ...)
   return res;
 }
 
+/**
+ * rest_proxy_set_user_agent:
+ * @proxy: a #RestProxy
+ * @user_agent: the user agent to set
+ *
+ * Sets the user agent of @proxy.
+ */
 void
 rest_proxy_set_user_agent (RestProxy  *proxy,
                            const char *user_agent)
@@ -522,6 +529,14 @@ rest_proxy_set_user_agent (RestProxy  *proxy,
   g_object_set (proxy, "user-agent", user_agent, NULL);
 }
 
+/**
+ * rest_proxy_get_user_agent:
+ * @proxy: a #RestProxy
+ *
+ * Returns: (nullable) (transfer none): The user agent set
+ *   using rest_proxy_set_user_agent() or %NULL if no user
+ *   agent has been set
+ */
 const gchar *
 rest_proxy_get_user_agent (RestProxy *proxy)
 {


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