summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorBrion Vibber <brion@pobox.com>2010-09-22 17:53:38 -0700
committerBrion Vibber <brion@pobox.com>2010-09-22 17:53:38 -0700
commit44ff13c947095fb2307d6e9a10362e940ef1b9af (patch)
tree4f362fe13e32e10358775d1849303e67b7f55419 /plugins
parent084befc32f6ddefc8aa7743dc0ad332a985c98f5 (diff)
More doc comments on SN_YammerClient
Diffstat (limited to 'plugins')
-rw-r--r--plugins/YammerImport/lib/sn_yammerclient.php11
1 files changed, 10 insertions, 1 deletions
diff --git a/plugins/YammerImport/lib/sn_yammerclient.php b/plugins/YammerImport/lib/sn_yammerclient.php
index 8f9f1d413..830f9dabb 100644
--- a/plugins/YammerImport/lib/sn_yammerclient.php
+++ b/plugins/YammerImport/lib/sn_yammerclient.php
@@ -139,8 +139,11 @@ class SN_YammerClient
}
/**
+ * Encode a key-value pair for use in an authentication header.
+ *
* @param string $key
* @param string $val
+ * @return string
*/
protected function authHeaderChunk($key, $val)
{
@@ -148,6 +151,9 @@ class SN_YammerClient
}
/**
+ * Ask the Yammer server for a request token, which can be passed on
+ * to authorizeUrl() for the user to start the authentication process.
+ *
* @return array of oauth return data; should contain nice things
*/
public function requestToken()
@@ -162,6 +168,9 @@ class SN_YammerClient
}
/**
+ * Get a final access token from the verifier/PIN code provided to
+ * the user from Yammer's auth pages.
+ *
* @return array of oauth return data; should contain nice things
*/
public function accessToken($verifier)
@@ -175,7 +184,7 @@ class SN_YammerClient
}
/**
- * Give the URL to send users to to authorize a new app setup
+ * Give the URL to send users to to authorize a new app setup.
*
* @param string $token as returned from accessToken()
* @return string URL