summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Burton <ross.burton@intel.com>2012-03-27 12:29:21 +0100
committerRoss Burton <ross.burton@intel.com>2012-03-27 12:29:21 +0100
commit3d8841357ce52a77579fa6fd572c722b31280cb4 (patch)
treeccc6847d6b612539399758f3b0ce5dfc47b055b7
parentd09f790e05047d1880c8034a562d6fad88da2643 (diff)
rest-proxy: add some basic documentation
-rw-r--r--rest/rest-proxy.c9
1 files changed, 9 insertions, 0 deletions
diff --git a/rest/rest-proxy.c b/rest/rest-proxy.c
index aeb056a..a84a53e 100644
--- a/rest/rest-proxy.c
+++ b/rest/rest-proxy.c
@@ -460,6 +460,15 @@ _rest_proxy_new_call (RestProxy *proxy)
return call;
}
+/**
+ * rest_proxy_new_call:
+ * @proxy: the #RestProxy
+ *
+ * Create a new #RestProxyCall for making a call to the web service. This call
+ * is one-shot and should not be re-used for making multiple calls.
+ *
+ * Returns: a new #RestProxyCall.
+ */
RestProxyCall *
rest_proxy_new_call (RestProxy *proxy)
{