Lots of small documentation updates and clarifications

This commit is contained in:
Alex Bilbie 2012-11-20 15:27:33 +00:00
parent fead044830
commit 958eab33a7

View File

@ -26,10 +26,22 @@ interface Database
* $redirectUri
* </code>
*
* Response:
*
* <code>
* Array
* (
* [client_id] => (string) The client ID
* [client secret] => (string) The client secret
* [redirect_uri] => (string) The redirect URI used in this request
* [name] => (string) The name of the client
* )
* </code>
*
* @param string $clientId The client's ID
* @param string $clientSecret The client's secret (default = "null")
* @param string $redirectUri The client's redirect URI (default = "null")
* @return [type] [description]
* @return bool|array Returns false if the validation fails, array on success
*/
public function validateClient(
$clientId,
@ -56,7 +68,7 @@ interface Database
* @param string $authCode The authorisation code (default = "null")
* @param string $accessToken The access token (default = "null")
* @param string $stage The stage of the session (default ="request")
* @return [type] [description]
* @return int The session ID
*/
public function newSession(
$clientId,
@ -105,7 +117,7 @@ interface Database
* @param string $clientId The client ID
* @param string $type The session owner's type
* @param string $typeId The session owner's ID
* @return [type] [description]
* @return void
*/
public function deleteSession(
$clientId,