update documentation of oc_user::checkpassword

lib/user.php

@@ -304,9 +304,10 @@ class OC_User {
 	 * @brief Check if the password is correct
 	 * @param $uid The username
 	 * @param $password The password
-	 * @returns true/false
+	 * @returns string
 	 *
 	 * Check if the password is correct without logging in the user
+	 * returns the user id or false
 	 */
 	public static function checkPassword( $uid, $password ){
 		foreach(self::$_usedBackends as $backend){

lib/user/database.php

@@ -117,9 +117,10 @@ class OC_User_Database extends OC_User_Backend {
 	 * @brief Check if the password is correct
 	 * @param $uid The username
 	 * @param $password The password
-	 * @returns true/false
+	 * @returns string
 	 *
 	 * Check if the password is correct without logging in the user
+	 * returns the user id or false
 	 */
 	public function checkPassword( $uid, $password ){
 		$query = OC_DB::prepare( "SELECT uid, password FROM *PREFIX*users WHERE uid = ?" );

lib/user/dummy.php

@@ -81,9 +81,10 @@ class OC_User_Dummy extends OC_User_Backend {
 		* @brief Check if the password is correct
 		* @param $uid The username
 		* @param $password The password
-		* @returns true/false
+		* @returns string
 		*
 		* Check if the password is correct without logging in the user
+		* returns the user id or false
 		*/
 	public function checkPassword($uid, $password){
 		if(isset($this->users[$uid])){

lib/user/example.php

@@ -66,9 +66,10 @@ abstract class OC_User_Example extends OC_User_Backend {
 		* @brief Check if the password is correct
 		* @param $uid The username
 		* @param $password The password
-		* @returns true/false
+		* @returns string
 		*
 		* Check if the password is correct without logging in the user
+		* returns the user id or false
 		*/
 	public function checkPassword($uid, $password){
 		return OC_USER_BACKEND_NOT_IMPLEMENTED;