summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Burton <ross@linux.intel.com>2009-08-04 12:34:58 +0100
committerRoss Burton <ross@linux.intel.com>2009-08-04 12:34:58 +0100
commita134200d9c9866dcfe415e4c4df4f526c27ee93c (patch)
treedcba4d79de946d2b345c21473972807389be54ef
parentd3ce3506231554e7ed119d7efcfc4f810719a31b (diff)
downloadlibrest-a134200d9c9866dcfe415e4c4df4f526c27ee93c.tar.gz
Clarify API documentation for the oauth_callback parameter
-rw-r--r--rest/oauth-proxy.c14
1 files changed, 6 insertions, 8 deletions
diff --git a/rest/oauth-proxy.c b/rest/oauth-proxy.c
index fb3bd51..e1e2e02 100644
--- a/rest/oauth-proxy.c
+++ b/rest/oauth-proxy.c
@@ -368,10 +368,9 @@ oauth_proxy_auth_step (OAuthProxy *proxy, const char *function, GError **error)
* Perform the Request Token phase of OAuth, invoking @function (defaulting to
* "request_token" if @function is NULL).
*
- * The value of @callback depends on whether the server supports OAuth 1.0 or
- * 1.0a. If it only supports 1.0 then callback can be NULL. If it supports
- * 1.0a then @callback should either be your callback URI, or "oob"
- * (out-of-band).
+ * The value of @callback depends on whether you wish to use OAuth 1.0 or 1.0a.
+ * If you wish to use 1.0 then callback must be NULL. To use 1.0a then
+ * @callback should either be your callback URI, or "oob" (out-of-band).
*
* Returns: %TRUE on success, or %FALSE on failure. On failure @error is set.
*/
@@ -422,10 +421,9 @@ oauth_proxy_request_token (OAuthProxy *proxy,
* Perform the Request Token phase of OAuth, invoking @function (defaulting to
* "request_token" if @function is NULL).
*
- * The value of @callback depends on whether the server supports OAuth 1.0 or
- * 1.0a. If it only supports 1.0 then callback can be NULL. If it supports
- * 1.0a then @callback should either be your callback URI, or "oob"
- * (out-of-band).
+ * The value of @callback depends on whether you wish to use OAuth 1.0 or 1.0a.
+ * If you wish to use 1.0 then callback must be NULL. To use 1.0a then
+ * @callback should either be your callback URI, or "oob" (out-of-band).
*
* This method will return once the method has been queued, @callback will be
* invoked when it has completed.