update documentation of oc_user::checkpassword

3 files changed, 6 insertions, 3 deletions

diff --git a/lib/user/database.php b/lib/user/database.php
index 4738a8948cb..894ccffb791 100644
--- a/lib/user/database.php
+++ b/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 = ?" );
diff --git a/lib/user/dummy.php b/lib/user/dummy.php
index cfc96c5c52d..03d5c3256da 100644
--- a/lib/user/dummy.php
+++ b/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])){
diff --git a/lib/user/example.php b/lib/user/example.php
index 7481014de77..b6a2091b685 100644
--- a/lib/user/example.php
+++ b/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;