summaryrefslogtreecommitdiffstats
path: root/lib/private/user/example.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/user/example.php')
-rw-r--r--lib/private/user/example.php30
1 files changed, 15 insertions, 15 deletions
diff --git a/lib/private/user/example.php b/lib/private/user/example.php
index b2d0dc25410..db21d6f9e52 100644
--- a/lib/private/user/example.php
+++ b/lib/private/user/example.php
@@ -27,10 +27,10 @@
*/
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
- * @returns true/false
+ * Create a new user
+ * @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.
@@ -38,20 +38,20 @@ abstract class OC_User_Example extends OC_User_Backend {
abstract public function createUser($uid, $password);
/**
- * @brief Set password
- * @param $uid The username
- * @param $password The new password
- * @returns true/false
+ * Set password
+ * @param string $uid The username
+ * @param string $password The new password
+ * @return bool
*
* Change the password of a user
*/
abstract public function setPassword($uid, $password);
/**
- * @brief Check if the password is correct
- * @param $uid The username
- * @param $password The password
- * @returns string
+ * Check if the password is correct
+ * @param string $uid The username
+ * @param string $password The password
+ * @return string
*
* Check if the password is correct without logging in the user
* returns the user id or false
@@ -59,9 +59,9 @@ abstract class OC_User_Example extends OC_User_Backend {
abstract public function checkPassword($uid, $password);
/**
- * @brief get the user's home directory
- * @param $uid The username
- * @returns string
+ * get the user's home directory
+ * @param string $uid The username
+ * @return string
*
* get the user's home directory
* returns the path or false