diff options
Diffstat (limited to 'lib/private/user')
| -rw-r--r-- | lib/private/user/database.php | 28 | ||||
| -rw-r--r-- | lib/private/user/example.php | 18 | ||||
| -rw-r--r-- | lib/private/user/http.php | 8 | ||||
| -rw-r--r-- | lib/private/user/interface.php | 12 |
4 files changed, 31 insertions, 35 deletions
diff --git a/lib/private/user/database.php b/lib/private/user/database.php index 284b3582598..747895a8a95 100644 --- a/lib/private/user/database.php +++ b/lib/private/user/database.php @@ -57,9 +57,9 @@ class OC_User_Database extends OC_User_Backend { /** * @brief Create a new user - * @param $uid The username of the user to create - * @param $password The password of the new user - * @return true/false + * @param string $uid The username of the user to create + * @param string $password The password of the new user + * @return bool * * Creates a new user. Basic checking of username is done in OC_User * itself, not in its subclasses. @@ -79,8 +79,8 @@ class OC_User_Database extends OC_User_Backend { /** * @brief delete a user - * @param $uid The username of the user to delete - * @return true/false + * @param string $uid The username of the user to delete + * @return bool * * Deletes a user */ @@ -98,9 +98,9 @@ class OC_User_Database extends OC_User_Backend { /** * @brief Set password - * @param $uid The username - * @param $password The new password - * @return true/false + * @param string $uid The username + * @param string $password The new password + * @return bool * * Change the password of a user */ @@ -119,9 +119,9 @@ class OC_User_Database extends OC_User_Backend { /** * @brief Set display name - * @param $uid The username - * @param $displayName The new display name - * @return true/false + * @param string $uid The username + * @param string $displayName The new display name + * @return bool * * Change the display name of a user */ @@ -139,7 +139,7 @@ class OC_User_Database extends OC_User_Backend { /** * @brief get display name of the user - * @param $uid user ID of the user + * @param string $uid user ID of the user * @return string display name */ public function getDisplayName($uid) { @@ -169,8 +169,8 @@ class OC_User_Database extends OC_User_Backend { /** * @brief Check if the password is correct - * @param $uid The username - * @param $password The password + * @param string $uid The username + * @param string $password The password * @return string * * Check if the password is correct without logging in the user diff --git a/lib/private/user/example.php b/lib/private/user/example.php index e6e2744b405..4bf3652330e 100644 --- a/lib/private/user/example.php +++ b/lib/private/user/example.php @@ -28,9 +28,9 @@ abstract class OC_User_Example extends OC_User_Backend { /** * @brief Create a new user - * @param $uid The username of the user to create - * @param $password The password of the new user - * @return true/false + * @param string $uid The username of the user to create + * @param string $password The password of the new user + * @return bool * * Creates a new user. Basic checking of username is done in OC_User * itself, not in its subclasses. @@ -39,9 +39,9 @@ abstract class OC_User_Example extends OC_User_Backend { /** * @brief Set password - * @param $uid The username - * @param $password The new password - * @return true/false + * @param string $uid The username + * @param string $password The new password + * @return bool * * Change the password of a user */ @@ -49,8 +49,8 @@ abstract class OC_User_Example extends OC_User_Backend { /** * @brief Check if the password is correct - * @param $uid The username - * @param $password The password + * @param string $uid The username + * @param string $password The password * @return string * * Check if the password is correct without logging in the user @@ -60,7 +60,7 @@ abstract class OC_User_Example extends OC_User_Backend { /** * @brief get the user's home directory - * @param $uid The username + * @param string $uid The username * @return string * * get the user's home directory diff --git a/lib/private/user/http.php b/lib/private/user/http.php index 806378a7c2c..67f7156b498 100644 --- a/lib/private/user/http.php +++ b/lib/private/user/http.php @@ -27,7 +27,7 @@ class OC_User_HTTP extends OC_User_Backend { /** * split http://user@host/path into a user and url part - * @param string path + * @param string $url * @return array */ private function parseUrl($url) { @@ -46,7 +46,7 @@ class OC_User_HTTP extends OC_User_Backend { /** * check if an url is a valid login - * @param string url + * @param string $url * @return boolean */ private function matchUrl($url) { @@ -55,8 +55,8 @@ class OC_User_HTTP extends OC_User_Backend { /** * @brief Check if the password is correct - * @param $uid The username - * @param $password The password + * @param string $uid The username + * @param string $password The password * @return string * * Check if the password is correct without logging in the user diff --git a/lib/private/user/interface.php b/lib/private/user/interface.php index 80da765cd9f..e130e5b569c 100644 --- a/lib/private/user/interface.php +++ b/lib/private/user/interface.php @@ -30,17 +30,13 @@ interface OC_User_Interface { * * Returns the supported actions as int to be * compared with OC_USER_BACKEND_CREATE_USER etc. - * @return boolean */ public function implementsActions($actions); /** * @brief delete a user - * @param $uid The username of the user to delete - * @return true/false - * - * Deletes a user - * @return boolean + * @param string $uid The username of the user to delete + * @return bool */ public function deleteUser($uid); @@ -61,8 +57,8 @@ interface OC_User_Interface { /** * @brief get display name of the user - * @param $uid user ID of the user - * @return display name + * @param string $uid user ID of the user + * @return string display name */ public function getDisplayName($uid); |