diff options
| author | Rob Bradford <rob@linux.intel.com> | 2010-09-02 11:13:32 +0100 |
|---|---|---|
| committer | Rob Bradford <rob@linux.intel.com> | 2010-09-02 11:17:55 +0100 |
| commit | 4284ddc378fe9c6cd200b5cedb9f15b8d0e42195 (patch) | |
| tree | 1a49967d2dc8fd20e3e88b1fc3e34925b35b9a65 | |
| parent | 6bd524ba785739705143f64c59684f973d20741f (diff) | |
| download | librest-4284ddc378fe9c6cd200b5cedb9f15b8d0e42195.tar.gz | |
proxy-call: Enhance documentation for rest_proxy_call_async
| -rw-r--r-- | rest/rest-proxy-call.c | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/rest/rest-proxy-call.c b/rest/rest-proxy-call.c index c90c75b..1a9bbb9 100644 --- a/rest/rest-proxy-call.c +++ b/rest/rest-proxy-call.c @@ -809,7 +809,11 @@ prepare_message (RestProxyCall *call, GError **error_out) * Asynchronously invoke @call. * * When the call has finished, @callback will be called. If @weak_object is - * disposed during the call then this call will be cancelled. + * disposed during the call then this call will be cancelled. If the call is + * cancelled then the callback will be invoked with an error state. + * + * You may unref the call after calling this function since there is an + * internal reference, or you may unref in the callback. */ gboolean rest_proxy_call_async (RestProxyCall *call, |