[librest] rest-proxy: add some basic documentation



commit 3d8841357ce52a77579fa6fd572c722b31280cb4
Author: Ross Burton <ross burton intel com>
Date:   Tue Mar 27 12:29:21 2012 +0100

    rest-proxy: add some basic documentation

 rest/rest-proxy.c |    9 +++++++++
 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)
 {



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