From b653ad164b83afbc07d7a82d2e4461dace28ba6a Mon Sep 17 00:00:00 2001 From: Robin McCorkell Date: Sun, 11 May 2014 18:05:28 +0100 Subject: [PATCH] Replace @returns with @return, in /lib --- lib/private/group.php | 6 +++--- lib/private/group/dummy.php | 18 +++++++++--------- lib/private/group/example.php | 16 ++++++++-------- lib/private/helper.php | 2 +- lib/private/installer.php | 2 +- lib/private/l10n.php | 20 ++++++++++---------- lib/private/ocsclient.php | 12 ++++++------ lib/private/request.php | 10 +++++----- lib/private/template/functions.php | 2 +- lib/private/user.php | 8 ++++---- lib/private/user/backend.php | 4 ++-- lib/private/user/database.php | 16 ++++++++-------- lib/private/user/example.php | 8 ++++---- lib/private/user/http.php | 2 +- lib/private/user/interface.php | 8 ++++---- lib/private/vobject.php | 6 +++--- lib/public/itags.php | 2 +- lib/public/util.php | 2 +- 18 files changed, 72 insertions(+), 72 deletions(-) diff --git a/lib/private/group.php b/lib/private/group.php index ea6384bae3..3191de5310 100644 --- a/lib/private/group.php +++ b/lib/private/group.php @@ -203,7 +203,7 @@ class OC_Group { * @param string $search * @param int|null $limit * @param int|null $offset - * @returns array with group names + * @return array with group names * * Returns a list with all groups */ @@ -232,7 +232,7 @@ class OC_Group { * @param string $search * @param int $limit * @param int $offset - * @returns array with user ids + * @return array with user ids */ public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { $group = self::getManager()->get($gid); @@ -271,7 +271,7 @@ class OC_Group { * @param string $search * @param int $limit * @param int $offset - * @returns array with display names (value) and user ids(key) + * @return array with display names (value) and user ids(key) */ public static function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { return self::getManager()->displayNamesInGroup($gid, $search, $limit, $offset); diff --git a/lib/private/group/dummy.php b/lib/private/group/dummy.php index 94cbb607ad..37987f2012 100644 --- a/lib/private/group/dummy.php +++ b/lib/private/group/dummy.php @@ -29,7 +29,7 @@ class OC_Group_Dummy extends OC_Group_Backend { /** * @brief Try to create a new group * @param string $gid The name of the group to create - * @returns true/false + * @return true/false * * Trys to create a new group. If the group name already exists, false will * be returned. @@ -46,7 +46,7 @@ class OC_Group_Dummy extends OC_Group_Backend { /** * @brief delete a group * @param $gid gid of the group to delete - * @returns true/false + * @return true/false * * Deletes a group and removes it from the group_user-table */ @@ -63,7 +63,7 @@ class OC_Group_Dummy extends OC_Group_Backend { * @brief is user in group? * @param $uid uid of the user * @param $gid gid of the group - * @returns true/false + * @return true/false * * Checks whether the user is member of a group or not. */ @@ -79,7 +79,7 @@ class OC_Group_Dummy extends OC_Group_Backend { * @brief Add a user to a group * @param $uid Name of the user to add to group * @param $gid Name of the group in which add the user - * @returns true/false + * @return true/false * * Adds a user to a group. */ @@ -100,7 +100,7 @@ class OC_Group_Dummy extends OC_Group_Backend { * @brief Removes a user from a group * @param $uid NameUSER of the user to remove from group * @param $gid Name of the group from which remove the user - * @returns true/false + * @return true/false * * removes the user from a group. */ @@ -119,7 +119,7 @@ class OC_Group_Dummy extends OC_Group_Backend { /** * @brief Get all groups a user belongs to * @param $uid Name of the user - * @returns array with group names + * @return array with group names * * This function fetches all groups a user belongs to. It does not check * if the user exists at all. @@ -137,7 +137,7 @@ class OC_Group_Dummy extends OC_Group_Backend { /** * @brief get a list of all groups - * @returns array with group names + * @return array with group names * * Returns a list with all groups */ @@ -147,7 +147,7 @@ class OC_Group_Dummy extends OC_Group_Backend { /** * @brief get a list of all users in a group - * @returns array with user ids + * @return array with user ids */ public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { if(isset($this->groups[$gid])) { @@ -159,7 +159,7 @@ class OC_Group_Dummy extends OC_Group_Backend { /** * @brief get the number of all users in a group - * @returns int | bool + * @return int | bool */ public function countUsersInGroup($gid, $search = '', $limit = -1, $offset = 0) { if(isset($this->groups[$gid])) { diff --git a/lib/private/group/example.php b/lib/private/group/example.php index 3519b9ed92..bcd6f81435 100644 --- a/lib/private/group/example.php +++ b/lib/private/group/example.php @@ -29,7 +29,7 @@ abstract class OC_Group_Example { /** * @brief Try to create a new group * @param $gid The name of the group to create - * @returns true/false + * @return true/false * * Trys to create a new group. If the group name already exists, false will * be returned. @@ -39,7 +39,7 @@ abstract class OC_Group_Example { /** * @brief delete a group * @param $gid gid of the group to delete - * @returns true/false + * @return true/false * * Deletes a group and removes it from the group_user-table */ @@ -49,7 +49,7 @@ abstract class OC_Group_Example { * @brief is user in group? * @param $uid uid of the user * @param $gid gid of the group - * @returns true/false + * @return true/false * * Checks whether the user is member of a group or not. */ @@ -59,7 +59,7 @@ abstract class OC_Group_Example { * @brief Add a user to a group * @param $uid Name of the user to add to group * @param $gid Name of the group in which add the user - * @returns true/false + * @return true/false * * Adds a user to a group. */ @@ -69,7 +69,7 @@ abstract class OC_Group_Example { * @brief Removes a user from a group * @param $uid NameUSER of the user to remove from group * @param $gid Name of the group from which remove the user - * @returns true/false + * @return true/false * * removes the user from a group. */ @@ -78,7 +78,7 @@ abstract class OC_Group_Example { /** * @brief Get all groups a user belongs to * @param $uid Name of the user - * @returns array with group names + * @return array with group names * * This function fetches all groups a user belongs to. It does not check * if the user exists at all. @@ -87,7 +87,7 @@ abstract class OC_Group_Example { /** * @brief get a list of all groups - * @returns array with group names + * @return array with group names * * Returns a list with all groups */ @@ -102,7 +102,7 @@ abstract class OC_Group_Example { /** * @brief get a list of all users in a group - * @returns array with user ids + * @return array with user ids */ abstract public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); diff --git a/lib/private/helper.php b/lib/private/helper.php index 6bc054bce8..ae95784608 100644 --- a/lib/private/helper.php +++ b/lib/private/helper.php @@ -36,7 +36,7 @@ class OC_Helper { * @param array $parameters * @return * @internal param array $args with param=>value, will be appended to the returned url - * @returns string the url + * @return string the url * * Returns a url to the given app and file. */ diff --git a/lib/private/installer.php b/lib/private/installer.php index 64e8e3a5e7..d7d43779d9 100644 --- a/lib/private/installer.php +++ b/lib/private/installer.php @@ -221,7 +221,7 @@ class OC_Installer{ /** * @brief checks whether or not an app is installed * @param string $app app - * @returns true/false + * @return true/false * * Checks whether or not an app is installed, i.e. registered in apps table. */ diff --git a/lib/private/l10n.php b/lib/private/l10n.php index c1596a6416..9ab60e871d 100644 --- a/lib/private/l10n.php +++ b/lib/private/l10n.php @@ -278,7 +278,7 @@ class OC_L10N implements \OCP\IL10N { /** * @brief getTranslations - * @returns array Fetch all translations + * @return array Fetch all translations * * Returns an associative array with all translations */ @@ -289,7 +289,7 @@ class OC_L10N implements \OCP\IL10N { /** * @brief getPluralFormString - * @returns string containing the gettext "Plural-Forms"-string + * @return string containing the gettext "Plural-Forms"-string * * Returns a string like "nplurals=2; plural=(n != 1);" */ @@ -300,7 +300,7 @@ class OC_L10N implements \OCP\IL10N { /** * @brief getPluralFormFunction - * @returns string the plural form function + * @return string the plural form function * * returned function accepts the argument $n */ @@ -314,7 +314,7 @@ class OC_L10N implements \OCP\IL10N { /** * @brief get localizations - * @returns array Fetch all localizations + * @return array Fetch all localizations * * Returns an associative array with all localizations */ @@ -327,7 +327,7 @@ class OC_L10N implements \OCP\IL10N { * @brief Localization * @param string $type Type of localization * @param array|int|string $data parameters for this localization - * @returns String or false + * @return String or false * * Returns the localized data. * @@ -381,7 +381,7 @@ class OC_L10N implements \OCP\IL10N { /** * @brief Choose a language * @param array $text Associative Array with possible strings - * @returns String + * @return String * * $text is an array 'de' => 'hallo welt', 'en' => 'hello world', ... * @@ -404,7 +404,7 @@ class OC_L10N implements \OCP\IL10N { /** * @brief find the best language * @param array|string $app details below - * @returns string language + * @return string language * * If $app is an array, ownCloud assumes that these are the available * languages. Otherwise ownCloud tries to find the files in the l10n @@ -477,7 +477,7 @@ class OC_L10N implements \OCP\IL10N { /** * @brief find the l10n directory * @param string $app App that needs to be translated - * @returns directory + * @return directory */ protected static function findI18nDir($app) { // find the i18n dir @@ -497,7 +497,7 @@ class OC_L10N implements \OCP\IL10N { /** * @brief find all available languages for an app * @param string $app App that needs to be translated - * @returns array an array of available languages + * @return array an array of available languages */ public static function findAvailableLanguages($app=null) { $available=array('en');//english is always available @@ -517,7 +517,7 @@ class OC_L10N implements \OCP\IL10N { /** * @param string $app * @param string $lang - * @returns bool + * @return bool */ public static function languageExists($app, $lang) { if ($lang == 'en') {//english is always available diff --git a/lib/private/ocsclient.php b/lib/private/ocsclient.php index b0480caf02..a08c862b0c 100644 --- a/lib/private/ocsclient.php +++ b/lib/private/ocsclient.php @@ -30,7 +30,7 @@ class OC_OCSClient{ /** * @brief Get the url of the OCS AppStore server. - * @returns string of the AppStore server + * @return string of the AppStore server * * This function returns the url of the OCS AppStore server. It´s possible * to set it in the config file or it will fallback to the default @@ -48,7 +48,7 @@ class OC_OCSClient{ /** * @brief Get the content of an OCS url call. - * @returns string of the response + * @return string of the response * This function calls an OCS server and returns the response. It also sets a sane timeout * @param string $url */ @@ -59,7 +59,7 @@ class OC_OCSClient{ /** * @brief Get all the categories from the OCS server - * @returns array with category ids + * @return array with category ids * @note returns NULL if config value appstoreenabled is set to false * This function returns a list of all the application categories on the OCS server */ @@ -92,7 +92,7 @@ class OC_OCSClient{ /** * @brief Get all the applications from the OCS server - * @returns array with application data + * @return array with application data * * This function returns a list of all the applications on the OCS server * @param $categories @@ -150,7 +150,7 @@ class OC_OCSClient{ /** * @brief Get an the applications from the OCS server * @param string $id - * @returns array with application data + * @return array with application data * * This function returns an applications from the OCS server */ @@ -192,7 +192,7 @@ class OC_OCSClient{ /** * @brief Get the download url for an application from the OCS server - * @returns array with application data + * @return array with application data * * This function returns an download url for an applications from the OCS server * @param string $id diff --git a/lib/private/request.php b/lib/private/request.php index 90f7488eea..cf9a316b85 100755 --- a/lib/private/request.php +++ b/lib/private/request.php @@ -18,7 +18,7 @@ class OC_Request { /** * @brief Check overwrite condition * @param string $type - * @returns bool + * @return bool */ private static function isOverwriteCondition($type = '') { $regex = '/' . OC_Config::getValue('overwritecondaddr', '') . '/'; @@ -49,7 +49,7 @@ class OC_Request { /** * @brief Returns the unverified server host from the headers without checking * whether it is a trusted domain - * @returns string the server host + * @return string the server host * * Returns the server host, even if the website uses one or more * reverse proxies @@ -89,7 +89,7 @@ class OC_Request { /** * @brief Returns the server host from the headers, or the first configured * trusted domain if the host isn't in the trusted list - * @returns string the server host + * @return string the server host * * Returns the server host, even if the website uses one or more * reverse proxies @@ -121,7 +121,7 @@ class OC_Request { /** * @brief Returns the server protocol - * @returns string the server protocol + * @return string the server protocol * * Returns the server protocol. It respects reverse proxy servers and load balancers */ @@ -143,7 +143,7 @@ class OC_Request { /** * @brief Returns the request uri - * @returns string the request uri + * @return string the request uri * * Returns the request uri, even if the website uses one or more * reverse proxies diff --git a/lib/private/template/functions.php b/lib/private/template/functions.php index 3c42d441ef..0a32dc48f2 100644 --- a/lib/private/template/functions.php +++ b/lib/private/template/functions.php @@ -71,7 +71,7 @@ function mimetype_icon( $mimetype ) { * @brief make preview_icon available as a simple function * Returns the path to the preview of the image. * @param $path path of file - * @returns link to the preview + * @return link to the preview * * For further information have a look at OC_Helper::previewIcon */ diff --git a/lib/private/user.php b/lib/private/user.php index 7106d664ac..bf101a29b9 100644 --- a/lib/private/user.php +++ b/lib/private/user.php @@ -77,7 +77,7 @@ class OC_User { /** * @brief gets available backends * @deprecated - * @returns array of backends + * @return array of backends * * Returns the names of all backends. */ @@ -88,7 +88,7 @@ class OC_User { /** * @brief gets used backends * @deprecated - * @returns array of backends + * @return array of backends * * Returns the names of all used backends. */ @@ -321,7 +321,7 @@ class OC_User { /** * @brief Check if the user is logged in - * @returns bool + * @return bool * * Checks if the user is logged in */ @@ -517,7 +517,7 @@ class OC_User { /** * @brief Get a list of all users - * @returns array with all uids + * @return array with all uids * * Get a list of all users. * @param string $search diff --git a/lib/private/user/backend.php b/lib/private/user/backend.php index f4e5618e04..3994c1bb8f 100644 --- a/lib/private/user/backend.php +++ b/lib/private/user/backend.php @@ -103,7 +103,7 @@ abstract class OC_User_Backend implements OC_User_Interface { /** * @brief Get a list of all users - * @returns array with all uids + * @return array with all uids * * Get a list of all users. */ @@ -140,7 +140,7 @@ abstract class OC_User_Backend implements OC_User_Interface { /** * @brief Get a list of all display names - * @returns array with all displayNames (value) and the corresponding uids (key) + * @return array with all displayNames (value) and the corresponding uids (key) * * Get a list of all display names and user ids. */ diff --git a/lib/private/user/database.php b/lib/private/user/database.php index dec38464f9..d70ccd8ad4 100644 --- a/lib/private/user/database.php +++ b/lib/private/user/database.php @@ -59,7 +59,7 @@ 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 - * @returns true/false + * @return true/false * * Creates a new user. Basic checking of username is done in OC_User * itself, not in its subclasses. @@ -80,7 +80,7 @@ class OC_User_Database extends OC_User_Backend { /** * @brief delete a user * @param $uid The username of the user to delete - * @returns true/false + * @return true/false * * Deletes a user */ @@ -100,7 +100,7 @@ class OC_User_Database extends OC_User_Backend { * @brief Set password * @param $uid The username * @param $password The new password - * @returns true/false + * @return true/false * * Change the password of a user */ @@ -121,7 +121,7 @@ class OC_User_Database extends OC_User_Backend { * @brief Set display name * @param $uid The username * @param $displayName The new display name - * @returns true/false + * @return true/false * * Change the display name of a user */ @@ -149,7 +149,7 @@ class OC_User_Database extends OC_User_Backend { /** * @brief Get a list of all display names - * @returns array with all displayNames (value) and the correspondig uids (key) + * @return array with all displayNames (value) and the correspondig uids (key) * * Get a list of all display names and user ids. */ @@ -171,7 +171,7 @@ class OC_User_Database extends OC_User_Backend { * @brief Check if the password is correct * @param $uid The username * @param $password The password - * @returns string + * @return string * * Check if the password is correct without logging in the user * returns the user id or false @@ -203,7 +203,7 @@ class OC_User_Database extends OC_User_Backend { /** * @brief Load an user in the cache * @param string $uid the username - * @returns boolean + * @return boolean */ private function loadUser($uid) { if (empty($this->cache[$uid])) { @@ -226,7 +226,7 @@ class OC_User_Database extends OC_User_Backend { /** * @brief Get a list of all users - * @returns array with all uids + * @return array with all uids * * Get a list of all users. */ diff --git a/lib/private/user/example.php b/lib/private/user/example.php index b2d0dc2541..e6e2744b40 100644 --- a/lib/private/user/example.php +++ b/lib/private/user/example.php @@ -30,7 +30,7 @@ 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 + * @return true/false * * Creates a new user. Basic checking of username is done in OC_User * itself, not in its subclasses. @@ -41,7 +41,7 @@ abstract class OC_User_Example extends OC_User_Backend { * @brief Set password * @param $uid The username * @param $password The new password - * @returns true/false + * @return true/false * * Change the password of a user */ @@ -51,7 +51,7 @@ 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 string + * @return string * * Check if the password is correct without logging in the user * returns the user id or false @@ -61,7 +61,7 @@ abstract class OC_User_Example extends OC_User_Backend { /** * @brief get the user's home directory * @param $uid The username - * @returns string + * @return string * * get the user's home directory * returns the path or false diff --git a/lib/private/user/http.php b/lib/private/user/http.php index a039452101..806378a7c2 100644 --- a/lib/private/user/http.php +++ b/lib/private/user/http.php @@ -57,7 +57,7 @@ class OC_User_HTTP extends OC_User_Backend { * @brief Check if the password is correct * @param $uid The username * @param $password The password - * @returns string + * @return string * * Check if the password is correct without logging in the user * returns the user id or false diff --git a/lib/private/user/interface.php b/lib/private/user/interface.php index cdcab3e5d0..eee18aea16 100644 --- a/lib/private/user/interface.php +++ b/lib/private/user/interface.php @@ -26,7 +26,7 @@ interface OC_User_Interface { /** * @brief Check if backend implements actions * @param $actions bitwise-or'ed actions - * @returns boolean + * @return boolean * * Returns the supported actions as int to be * compared with OC_USER_BACKEND_CREATE_USER etc. @@ -37,7 +37,7 @@ interface OC_User_Interface { /** * @brief delete a user * @param $uid The username of the user to delete - * @returns true/false + * @return true/false * * Deletes a user * @return boolean @@ -46,7 +46,7 @@ interface OC_User_Interface { /** * @brief Get a list of all users - * @returns array with all uids + * @return array with all uids * * Get a list of all users. */ @@ -68,7 +68,7 @@ interface OC_User_Interface { /** * @brief Get a list of all display names - * @returns array with all displayNames (value) and the corresponding uids (key) + * @return array with all displayNames (value) and the corresponding uids (key) * * Get a list of all display names and user ids. */ diff --git a/lib/private/vobject.php b/lib/private/vobject.php index a3e9f7ef79..20cacd926b 100644 --- a/lib/private/vobject.php +++ b/lib/private/vobject.php @@ -28,7 +28,7 @@ class OC_VObject{ protected $vobject; /** - * @returns Sabre\VObject\Component + * @return Sabre\VObject\Component */ public function getVObject() { return $this->vobject; @@ -37,7 +37,7 @@ class OC_VObject{ /** * @brief Parses the VObject * @param string $data VObject as string - * @returns Sabre\VObject\Reader|null + * @return Sabre\VObject\Reader|null */ public static function parse($data) { try { @@ -116,7 +116,7 @@ class OC_VObject{ * @param object $name of property * @param object $value of property * @param array|object $parameters of property - * @returns Sabre\VObject\Property newly created + * @return Sabre\VObject\Property newly created */ public function addProperty($name, $value, $parameters=array()) { if(is_array($value)) { diff --git a/lib/public/itags.php b/lib/public/itags.php index f8ebaa668f..1cba07e9b5 100644 --- a/lib/public/itags.php +++ b/lib/public/itags.php @@ -62,7 +62,7 @@ interface ITags { * ['id' => 1, 'name' = 'Second tag'], * ] * - * @returns array + * @return array */ public function getTags(); diff --git a/lib/public/util.php b/lib/public/util.php index 3b0fc09f7e..006a828dca 100644 --- a/lib/public/util.php +++ b/lib/public/util.php @@ -293,7 +293,7 @@ class Util { /** * Returns the script name, even if the website uses one or more reverse proxies - * @returns string the script name + * @return string the script name */ public static function getScriptName() { return(\OC_Request::scriptName());