From dc36d3095314db8d88c2ec1005d99af595c119da Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Mon, 19 May 2014 17:50:53 +0200 Subject: Remove all occurences of @brief and @returns from PHPDoc * test case added to avoid adding them later --- lib/private/group/backend.php | 12 ++++++------ lib/private/group/database.php | 18 +++++++++--------- lib/private/group/dummy.php | 18 +++++++++--------- lib/private/group/example.php | 18 +++++++++--------- lib/private/group/group.php | 2 +- lib/private/group/interface.php | 10 +++++----- lib/private/group/manager.php | 2 +- 7 files changed, 40 insertions(+), 40 deletions(-) (limited to 'lib/private/group') diff --git a/lib/private/group/backend.php b/lib/private/group/backend.php index 38522d0c43c..ab694268bb3 100644 --- a/lib/private/group/backend.php +++ b/lib/private/group/backend.php @@ -49,7 +49,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { ); /** - * @brief Get all supported actions + * Get all supported actions * @return int bitwise-or'ed actions * * Returns the supported actions as int to be @@ -67,7 +67,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param int $actions bitwise-or'ed actions * @return bool * @@ -79,7 +79,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -91,7 +91,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -103,7 +103,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief get a list of all groups + * get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -126,7 +126,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief get a list of all users in a group + * get a list of all users in a group * @param string $gid * @param string $search * @param int $limit diff --git a/lib/private/group/database.php b/lib/private/group/database.php index 91baa3140cc..baaf2cf2739 100644 --- a/lib/private/group/database.php +++ b/lib/private/group/database.php @@ -43,7 +43,7 @@ class OC_Group_Database extends OC_Group_Backend { /** - * @brief Try to create a new group + * Try to create a new group * @param string $gid The name of the group to create * @return bool * @@ -69,7 +69,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief delete a group + * delete a group * @param string $gid gid of the group to delete * @return bool * @@ -88,7 +88,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -104,7 +104,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief Add a user to a group + * Add a user to a group * @param string $uid Name of the user to add to group * @param string $gid Name of the group in which add the user * @return bool @@ -123,7 +123,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief Removes a user from a group + * Removes a user from a group * @param string $uid Name of the user to remove from group * @param string $gid Name of the group from which remove the user * @return bool @@ -138,7 +138,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -159,7 +159,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief get a list of all groups + * get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -192,7 +192,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief get a list of all users in a group + * get a list of all users in a group * @param string $gid * @param string $search * @param int $limit @@ -212,7 +212,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief get the number of all users matching the search string in a group + * get the number of all users matching the search string in a group * @param string $gid * @param string $search * @return int|false diff --git a/lib/private/group/dummy.php b/lib/private/group/dummy.php index 75bab31a337..e48c6a0e266 100644 --- a/lib/private/group/dummy.php +++ b/lib/private/group/dummy.php @@ -27,7 +27,7 @@ class OC_Group_Dummy extends OC_Group_Backend { private $groups=array(); /** - * @brief Try to create a new group + * Try to create a new group * @param string $gid The name of the group to create * @return bool * @@ -44,7 +44,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief delete a group + * delete a group * @param string $gid gid of the group to delete * @return bool * @@ -60,7 +60,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -76,7 +76,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Add a user to a group + * Add a user to a group * @param string $uid Name of the user to add to group * @param string $gid Name of the group in which add the user * @return bool @@ -97,7 +97,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Removes a user from a group + * Removes a user from a group * @param string $uid Name of the user to remove from group * @param string $gid Name of the group from which remove the user * @return bool @@ -117,7 +117,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -136,7 +136,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Get a list of all groups + * Get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -147,7 +147,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Get a list of all users in a group + * Get a list of all users in a group * @param string $gid * @param string $search * @param int $limit @@ -163,7 +163,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief get the number of all users in a group + * get the number of all users in a group * @param string $gid * @param string $search * @param int $limit diff --git a/lib/private/group/example.php b/lib/private/group/example.php index 76c9ce2433d..8c1e22866f2 100644 --- a/lib/private/group/example.php +++ b/lib/private/group/example.php @@ -27,7 +27,7 @@ */ abstract class OC_Group_Example { /** - * @brief Try to create a new group + * Try to create a new group * @param string $gid The name of the group to create * @return bool * @@ -37,7 +37,7 @@ abstract class OC_Group_Example { abstract public static function createGroup($gid); /** - * @brief delete a group + * delete a group * @param string $gid gid of the group to delete * @return bool * @@ -46,7 +46,7 @@ abstract class OC_Group_Example { abstract public static function deleteGroup($gid); /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -56,7 +56,7 @@ abstract class OC_Group_Example { abstract public static function inGroup($uid, $gid); /** - * @brief Add a user to a group + * Add a user to a group * @param string $uid Name of the user to add to group * @param string $gid Name of the group in which add the user * @return bool @@ -66,7 +66,7 @@ abstract class OC_Group_Example { abstract public static function addToGroup($uid, $gid); /** - * @brief Removes a user from a group + * Removes a user from a group * @param string $uid Name of the user to remove from group * @param string $gid Name of the group from which remove the user * @return bool @@ -76,7 +76,7 @@ abstract class OC_Group_Example { abstract public static function removeFromGroup($uid, $gid); /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -86,7 +86,7 @@ abstract class OC_Group_Example { abstract public static function getUserGroups($uid); /** - * @brief get a list of all groups + * get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -95,14 +95,14 @@ abstract class OC_Group_Example { abstract public static function getGroups($search = '', $limit = -1, $offset = 0); /** - * @brief Check if a group exists + * Check if a group exists * @param string $gid * @return bool */ abstract public function groupExists($gid); /** - * @brief get a list of all users in a group + * get a list of all users in a group * @param string $gid * @param string $search * @param int $limit diff --git a/lib/private/group/group.php b/lib/private/group/group.php index 69641854dc5..3e245ab6bbe 100644 --- a/lib/private/group/group.php +++ b/lib/private/group/group.php @@ -244,7 +244,7 @@ class Group { } /** - * @brief returns all the Users from an array that really exists + * returns all the Users from an array that really exists * @param string[] $userIds an array containing user IDs * @return \OC\User\User[] an Array with the userId as Key and \OC\User\User as value */ diff --git a/lib/private/group/interface.php b/lib/private/group/interface.php index 74d288d42c0..ee5c2d635d6 100644 --- a/lib/private/group/interface.php +++ b/lib/private/group/interface.php @@ -23,7 +23,7 @@ interface OC_Group_Interface { /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param int $actions bitwise-or'ed actions * @return boolean * @@ -33,7 +33,7 @@ interface OC_Group_Interface { public function implementsActions($actions); /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -43,7 +43,7 @@ interface OC_Group_Interface { public function inGroup($uid, $gid); /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -53,7 +53,7 @@ interface OC_Group_Interface { public function getUserGroups($uid); /** - * @brief get a list of all groups + * get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -71,7 +71,7 @@ interface OC_Group_Interface { public function groupExists($gid); /** - * @brief get a list of all users in a group + * get a list of all users in a group * @param string $gid * @param string $search * @param int $limit diff --git a/lib/private/group/manager.php b/lib/private/group/manager.php index 707009fb3d4..dae6443e9d4 100644 --- a/lib/private/group/manager.php +++ b/lib/private/group/manager.php @@ -184,7 +184,7 @@ class Manager extends PublicEmitter { } /** - * @brief get a list of all display names in a group + * get a list of all display names in a group * @param string $gid * @param string $search * @param int $limit -- cgit v1.2.3