aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/user
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
committerMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
commitdc36d3095314db8d88c2ec1005d99af595c119da (patch)
tree9de515019d7ebae43a545e5dc4eb522ef71dbe9c /lib/private/user
parent95741f3936501e3ad6aeb26f93eeb28f9decc273 (diff)
downloadnextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.tar.gz
nextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.zip
Remove all occurences of @brief and @returns from PHPDoc
* test case added to avoid adding them later
Diffstat (limited to 'lib/private/user')
-rw-r--r--lib/private/user/backend.php18
-rw-r--r--lib/private/user/database.php22
-rw-r--r--lib/private/user/dummy.php12
-rw-r--r--lib/private/user/example.php8
-rw-r--r--lib/private/user/http.php6
-rw-r--r--lib/private/user/interface.php14
6 files changed, 40 insertions, 40 deletions
diff --git a/lib/private/user/backend.php b/lib/private/user/backend.php
index 8d2f0e935de..56c63085f18 100644
--- a/lib/private/user/backend.php
+++ b/lib/private/user/backend.php
@@ -61,7 +61,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
);
/**
- * @brief Get all supported actions
+ * Get all supported actions
* @return int bitwise-or'ed actions
*
* Returns the supported actions as int to be
@@ -79,7 +79,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
}
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param int $actions bitwise-or'ed actions
* @return boolean
*
@@ -91,7 +91,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
}
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*
@@ -102,7 +102,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
}
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @return array an array of all uids
*
* Get a list of all users.
@@ -112,7 +112,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
@@ -121,7 +121,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
}
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid the username
* @return boolean
*/
@@ -130,7 +130,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
}
/**
- * @brief get display name of the user
+ * get display name of the user
* @param string $uid user ID of the user
* @return string display name
*/
@@ -139,7 +139,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
}
/**
- * @brief Get a list of all display names
+ * Get a list of all display names
* @return array an array of all displayNames (value) and the corresponding uids (key)
*
* Get a list of all display names and user ids.
@@ -154,7 +154,7 @@ abstract class OC_User_Backend implements OC_User_Interface {
}
/**
- * @brief Check if a user list is available or not
+ * Check if a user list is available or not
* @return boolean if users can be listed or not
*/
public function hasUserListings() {
diff --git a/lib/private/user/database.php b/lib/private/user/database.php
index 747895a8a95..d9263f6b5de 100644
--- a/lib/private/user/database.php
+++ b/lib/private/user/database.php
@@ -56,7 +56,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief Create a new user
+ * 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
@@ -78,7 +78,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*
@@ -97,7 +97,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief Set password
+ * Set password
* @param string $uid The username
* @param string $password The new password
* @return bool
@@ -118,7 +118,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief Set display name
+ * Set display name
* @param string $uid The username
* @param string $displayName The new display name
* @return bool
@@ -138,7 +138,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief get display name of the user
+ * get display name of the user
* @param string $uid user ID of the user
* @return string display name
*/
@@ -148,7 +148,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief Get a list of all display names
+ * Get a list of all display names
* @return array an array of all displayNames (value) and the correspondig uids (key)
*
* Get a list of all display names and user ids.
@@ -168,7 +168,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string
@@ -201,7 +201,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief Load an user in the cache
+ * Load an user in the cache
* @param string $uid the username
* @return boolean
*/
@@ -225,7 +225,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @return array an array of all uids
*
* Get a list of all users.
@@ -241,7 +241,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
@@ -251,7 +251,7 @@ class OC_User_Database extends OC_User_Backend {
}
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid the username
* @return string|false
*/
diff --git a/lib/private/user/dummy.php b/lib/private/user/dummy.php
index d2ada37c80f..776168048f6 100644
--- a/lib/private/user/dummy.php
+++ b/lib/private/user/dummy.php
@@ -28,7 +28,7 @@ class OC_User_Dummy extends OC_User_Backend {
private $users = array();
/**
- * @brief Create a new user
+ * 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
@@ -46,7 +46,7 @@ class OC_User_Dummy extends OC_User_Backend {
}
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*
@@ -62,7 +62,7 @@ class OC_User_Dummy extends OC_User_Backend {
}
/**
- * @brief Set password
+ * Set password
* @param string $uid The username
* @param string $password The new password
* @return bool
@@ -79,7 +79,7 @@ class OC_User_Dummy extends OC_User_Backend {
}
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string
@@ -96,7 +96,7 @@ class OC_User_Dummy extends OC_User_Backend {
}
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @param string $search
* @param int $limit
* @param int $offset
@@ -109,7 +109,7 @@ class OC_User_Dummy extends OC_User_Backend {
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
diff --git a/lib/private/user/example.php b/lib/private/user/example.php
index 4bf3652330e..db21d6f9e52 100644
--- a/lib/private/user/example.php
+++ b/lib/private/user/example.php
@@ -27,7 +27,7 @@
*/
abstract class OC_User_Example extends OC_User_Backend {
/**
- * @brief Create a new user
+ * 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
@@ -38,7 +38,7 @@ abstract class OC_User_Example extends OC_User_Backend {
abstract public function createUser($uid, $password);
/**
- * @brief Set password
+ * Set password
* @param string $uid The username
* @param string $password The new password
* @return bool
@@ -48,7 +48,7 @@ abstract class OC_User_Example extends OC_User_Backend {
abstract public function setPassword($uid, $password);
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string
@@ -59,7 +59,7 @@ abstract class OC_User_Example extends OC_User_Backend {
abstract public function checkPassword($uid, $password);
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid The username
* @return string
*
diff --git a/lib/private/user/http.php b/lib/private/user/http.php
index 67f7156b498..2bb8b4c864a 100644
--- a/lib/private/user/http.php
+++ b/lib/private/user/http.php
@@ -54,7 +54,7 @@ class OC_User_HTTP extends OC_User_Backend {
}
/**
- * @brief Check if the password is correct
+ * Check if the password is correct
* @param string $uid The username
* @param string $password The password
* @return string
@@ -87,7 +87,7 @@ class OC_User_HTTP extends OC_User_Backend {
}
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
@@ -96,7 +96,7 @@ class OC_User_HTTP extends OC_User_Backend {
}
/**
- * @brief get the user's home directory
+ * get the user's home directory
* @param string $uid the username
* @return string|false
*/
diff --git a/lib/private/user/interface.php b/lib/private/user/interface.php
index e130e5b569c..4cdc47479a3 100644
--- a/lib/private/user/interface.php
+++ b/lib/private/user/interface.php
@@ -24,7 +24,7 @@
interface OC_User_Interface {
/**
- * @brief Check if backend implements actions
+ * Check if backend implements actions
* @param $actions bitwise-or'ed actions
* @return boolean
*
@@ -34,14 +34,14 @@ interface OC_User_Interface {
public function implementsActions($actions);
/**
- * @brief delete a user
+ * delete a user
* @param string $uid The username of the user to delete
* @return bool
*/
public function deleteUser($uid);
/**
- * @brief Get a list of all users
+ * Get a list of all users
* @return array an array of all uids
*
* Get a list of all users.
@@ -49,21 +49,21 @@ interface OC_User_Interface {
public function getUsers($search = '', $limit = null, $offset = null);
/**
- * @brief check if a user exists
+ * check if a user exists
* @param string $uid the username
* @return boolean
*/
public function userExists($uid);
/**
- * @brief get display name of the user
+ * get display name of the user
* @param string $uid user ID of the user
* @return string display name
*/
public function getDisplayName($uid);
/**
- * @brief Get a list of all display names
+ * Get a list of all display names
* @return array an array of all displayNames (value) and the corresponding uids (key)
*
* Get a list of all display names and user ids.
@@ -71,7 +71,7 @@ interface OC_User_Interface {
public function getDisplayNames($search = '', $limit = null, $offset = null);
/**
- * @brief Check if a user list is available or not
+ * Check if a user list is available or not
* @return boolean if users can be listed or not
*/
public function hasUserListings();