From b653ad164b83afbc07d7a82d2e4461dace28ba6a Mon Sep 17 00:00:00 2001 From: Robin McCorkell Date: Sun, 11 May 2014 18:05:28 +0100 Subject: Replace @returns with @return, in /lib --- lib/private/group.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'lib/private/group.php') diff --git a/lib/private/group.php b/lib/private/group.php index ea6384bae3e..3191de5310a 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); -- cgit v1.2.3 From b5bc37d2e40aba0ab8d3e72e7f7075352839096d Mon Sep 17 00:00:00 2001 From: Robin McCorkell Date: Sun, 11 May 2014 18:13:51 +0100 Subject: Fix @return array PHPDocs, in /lib --- lib/private/app.php | 4 ++-- lib/private/appconfig.php | 4 ++-- lib/private/config.php | 2 +- lib/private/contactsmanager.php | 4 ++-- lib/private/files/cache/cache.php | 2 +- lib/private/files/cache/scanner.php | 6 +++--- lib/private/files/cache/updater.php | 2 +- lib/private/files/filesystem.php | 2 +- lib/private/files/view.php | 2 +- lib/private/group.php | 12 ++++++------ lib/private/group/backend.php | 6 +++--- lib/private/group/database.php | 6 +++--- lib/private/group/dummy.php | 6 +++--- lib/private/group/example.php | 6 +++--- lib/private/group/interface.php | 6 +++--- lib/private/group/manager.php | 2 +- lib/private/legacy/appconfig.php | 4 ++-- lib/private/legacy/config.php | 2 +- lib/private/legacy/preferences.php | 4 ++-- lib/private/migrate.php | 2 +- lib/private/navigationmanager.php | 2 +- lib/private/ocsclient.php | 8 ++++---- lib/private/preferences.php | 4 ++-- lib/private/preview.php | 2 +- lib/private/share/mailnotifications.php | 2 +- lib/private/user.php | 6 +++--- lib/private/user/backend.php | 4 ++-- lib/private/user/database.php | 4 ++-- lib/private/user/interface.php | 4 ++-- lib/private/user/manager.php | 2 +- lib/private/util.php | 2 +- lib/public/backgroundjob.php | 4 ++-- lib/public/contacts.php | 4 ++-- lib/public/contacts/imanager.php | 4 ++-- lib/public/iaddressbook.php | 4 ++-- lib/public/iappconfig.php | 4 ++-- lib/public/user.php | 4 ++-- lib/public/util.php | 2 +- 38 files changed, 75 insertions(+), 75 deletions(-) (limited to 'lib/private/group.php') diff --git a/lib/private/app.php b/lib/private/app.php index 2f55b54b328..a35248f2552 100644 --- a/lib/private/app.php +++ b/lib/private/app.php @@ -307,7 +307,7 @@ class OC_App{ /** * @brief Get the navigation entries for the $app * @param string $app app - * @return array of the $data added with addNavigationEntry + * @return array an array of the $data added with addNavigationEntry * * Warning: destroys the existing entries */ @@ -660,7 +660,7 @@ class OC_App{ /** * @brief: get a list of all apps in the apps folder - * @return array or app names (string IDs) + * @return array an array of app names (string IDs) * @todo: change the name of this method to getInstalledApps, which is more accurate */ public static function getAllApps() { diff --git a/lib/private/appconfig.php b/lib/private/appconfig.php index 0cd6b3bc35b..5fba7514de0 100644 --- a/lib/private/appconfig.php +++ b/lib/private/appconfig.php @@ -90,7 +90,7 @@ class AppConfig implements \OCP\IAppConfig { /** * @brief Get all apps using the config - * @return array with app ids + * @return array an array of app ids * * This function returns a list of all apps that have at least one * entry in the appconfig table. @@ -109,7 +109,7 @@ class AppConfig implements \OCP\IAppConfig { /** * @brief Get the available keys for an app * @param string $app the app we are looking for - * @return array with key names + * @return array an array of key names * * This function gets all keys of an app. Please note that the values are * not returned. diff --git a/lib/private/config.php b/lib/private/config.php index 6701ca0532b..2320db9d6bd 100644 --- a/lib/private/config.php +++ b/lib/private/config.php @@ -65,7 +65,7 @@ class Config { /** * @brief Lists all available config keys - * @return array with key names + * @return array an array of key names * * This function returns all keys saved in config.php. Please note that it * does not return the values. diff --git a/lib/private/contactsmanager.php b/lib/private/contactsmanager.php index 4299d88017a..26264d4e988 100644 --- a/lib/private/contactsmanager.php +++ b/lib/private/contactsmanager.php @@ -31,7 +31,7 @@ namespace OC { * @param string $pattern which should match within the $searchProperties * @param array $searchProperties defines the properties within the query pattern should match * @param array $options - for future use. One should always have options! - * @return array of contacts which are arrays of key-value-pairs + * @return array an array of contacts which are arrays of key-value-pairs */ public function search($pattern, $searchProperties = array(), $options = array()) { $result = array(); @@ -72,7 +72,7 @@ namespace OC { * * @param array $properties this array if key-value-pairs defines a contact * @param string $address_book_key identifier of the address book in which the contact shall be created or updated - * @return array representing the contact just created or updated + * @return array an array representing the contact just created or updated */ public function createOrUpdate($properties, $address_book_key) { diff --git a/lib/private/files/cache/cache.php b/lib/private/files/cache/cache.php index c4f03b4d9ef..e857d451881 100644 --- a/lib/private/files/cache/cache.php +++ b/lib/private/files/cache/cache.php @@ -450,7 +450,7 @@ class Cache { * search for files matching $pattern * * @param string $pattern - * @return array of file data + * @return array an array of file data */ public function search($pattern) { diff --git a/lib/private/files/cache/scanner.php b/lib/private/files/cache/scanner.php index c0bdde06a75..8c2ec057ca7 100644 --- a/lib/private/files/cache/scanner.php +++ b/lib/private/files/cache/scanner.php @@ -61,7 +61,7 @@ class Scanner extends BasicEmitter { * * * * @param string $path - * @return array with metadata of the file + * @return array an array of metadata of the file */ public function getData($path) { if (!$this->storage->isReadable($path)) { @@ -88,7 +88,7 @@ class Scanner extends BasicEmitter { * @param string $file * @param int $reuseExisting * @param bool $parentExistsInCache - * @return array with metadata of the scanned file + * @return array an array of metadata of the scanned file */ public function scanFile($file, $reuseExisting = 0, $parentExistsInCache = false) { if (!self::isPartialFile($file) @@ -174,7 +174,7 @@ class Scanner extends BasicEmitter { * @param string $path * @param bool $recursive * @param int $reuse - * @return array with the meta data of the scanned file or folder + * @return array an array of the meta data of the scanned file or folder */ public function scan($path, $recursive = self::SCAN_RECURSIVE, $reuse = -1) { if ($reuse === -1) { diff --git a/lib/private/files/cache/updater.php b/lib/private/files/cache/updater.php index 199ce5dee78..95f77a81fa2 100644 --- a/lib/private/files/cache/updater.php +++ b/lib/private/files/cache/updater.php @@ -17,7 +17,7 @@ class Updater { * resolve a path to a storage and internal path * * @param string $path the relative path - * @return array consisting of the storage and the internal path + * @return array an array consisting of the storage and the internal path */ static public function resolvePath($path) { $view = \OC\Files\Filesystem::getView(); diff --git a/lib/private/files/filesystem.php b/lib/private/files/filesystem.php index 52df1bec611..a4994e4dfb6 100644 --- a/lib/private/files/filesystem.php +++ b/lib/private/files/filesystem.php @@ -270,7 +270,7 @@ class Filesystem { * resolve a path to a storage and internal path * * @param string $path - * @return array consisting of the storage and the internal path + * @return array an array consisting of the storage and the internal path */ static public function resolvePath($path) { if (!self::$mounts) { diff --git a/lib/private/files/view.php b/lib/private/files/view.php index 39c71cfc0b0..d3772e264a0 100644 --- a/lib/private/files/view.php +++ b/lib/private/files/view.php @@ -109,7 +109,7 @@ class View { * resolve a path to a storage and internal path * * @param string $path - * @return array consisting of the storage and the internal path + * @return array an array consisting of the storage and the internal path */ public function resolvePath($path) { $a = $this->getAbsolutePath($path); diff --git a/lib/private/group.php b/lib/private/group.php index 3191de5310a..5b291d7f2f6 100644 --- a/lib/private/group.php +++ b/lib/private/group.php @@ -179,7 +179,7 @@ class OC_Group { /** * @brief Get all groups a user belongs to * @param string $uid Name of the user - * @return array with group names + * @return array an array of group names * * This function fetches all groups a user belongs to. It does not check * if the user exists at all. @@ -203,7 +203,7 @@ class OC_Group { * @param string $search * @param int|null $limit * @param int|null $offset - * @return array with group names + * @return array an array of group names * * Returns a list with all groups */ @@ -232,7 +232,7 @@ class OC_Group { * @param string $search * @param int $limit * @param int $offset - * @return array with user ids + * @return array an array of user ids */ public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { $group = self::getManager()->get($gid); @@ -254,7 +254,7 @@ class OC_Group { * @param string $search * @param int $limit * @param int $offset - * @return array with user ids + * @return array an array of user ids */ public static function usersInGroups($gids, $search = '', $limit = -1, $offset = 0) { $users = array(); @@ -271,7 +271,7 @@ class OC_Group { * @param string $search * @param int $limit * @param int $offset - * @return array with display names (value) and user ids(key) + * @return array an array of 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); @@ -283,7 +283,7 @@ class OC_Group { * @param string $search * @param int $limit * @param int $offset - * @return array with display names (Key) user ids (value) + * @return array an array of display names (Key) user ids (value) */ public static function displayNamesInGroups($gids, $search = '', $limit = -1, $offset = 0) { $displayNames = array(); diff --git a/lib/private/group/backend.php b/lib/private/group/backend.php index cc61fce1615..c1de99bca58 100644 --- a/lib/private/group/backend.php +++ b/lib/private/group/backend.php @@ -93,7 +93,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { /** * @brief Get all groups a user belongs to * @param string $uid Name of the user - * @return array with group names + * @return array an array of group names * * This function fetches all groups a user belongs to. It does not check * if the user exists at all. @@ -107,7 +107,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { * @param string $search * @param int $limit * @param int $offset - * @return array with group names + * @return array an array of group names * * Returns a list with all groups */ @@ -131,7 +131,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { * @param string $search * @param int $limit * @param int $offset - * @return array with user ids + * @return array an array of user ids */ public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { return array(); diff --git a/lib/private/group/database.php b/lib/private/group/database.php index df0d84d0d2a..abdf09a9222 100644 --- a/lib/private/group/database.php +++ b/lib/private/group/database.php @@ -140,7 +140,7 @@ class OC_Group_Database extends OC_Group_Backend { /** * @brief Get all groups a user belongs to * @param string $uid Name of the user - * @return array with group names + * @return array an array of group names * * This function fetches all groups a user belongs to. It does not check * if the user exists at all. @@ -163,7 +163,7 @@ class OC_Group_Database extends OC_Group_Backend { * @param string $search * @param int $limit * @param int $offset - * @return array with group names + * @return array an array of group names * * Returns a list with all groups */ @@ -197,7 +197,7 @@ class OC_Group_Database extends OC_Group_Backend { * @param string $search * @param int $limit * @param int $offset - * @return array with user ids + * @return array an array of user ids */ public function usersInGroup($gid, $search = '', $limit = null, $offset = null) { $stmt = OC_DB::prepare('SELECT `uid` FROM `*PREFIX*group_user` WHERE `gid` = ? AND `uid` LIKE ?', diff --git a/lib/private/group/dummy.php b/lib/private/group/dummy.php index 37987f20128..1ef81c6bf99 100644 --- a/lib/private/group/dummy.php +++ b/lib/private/group/dummy.php @@ -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 - * @return array with group names + * @return array an array of 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 - * @return array with group names + * @return array an array of 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 - * @return array with user ids + * @return array an array of user ids */ public function usersInGroup($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 bcd6f814356..12be5421c1c 100644 --- a/lib/private/group/example.php +++ b/lib/private/group/example.php @@ -78,7 +78,7 @@ abstract class OC_Group_Example { /** * @brief Get all groups a user belongs to * @param $uid Name of the user - * @return array with group names + * @return array an array of 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 - * @return array with group names + * @return array an array of 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 - * @return array with user ids + * @return array an array of user ids */ abstract public static function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); diff --git a/lib/private/group/interface.php b/lib/private/group/interface.php index 4ef3663837f..74d288d42c0 100644 --- a/lib/private/group/interface.php +++ b/lib/private/group/interface.php @@ -45,7 +45,7 @@ interface OC_Group_Interface { /** * @brief Get all groups a user belongs to * @param string $uid Name of the user - * @return array with group names + * @return array an array of group names * * This function fetches all groups a user belongs to. It does not check * if the user exists at all. @@ -57,7 +57,7 @@ interface OC_Group_Interface { * @param string $search * @param int $limit * @param int $offset - * @return array with group names + * @return array an array of group names * * Returns a list with all groups */ @@ -76,7 +76,7 @@ interface OC_Group_Interface { * @param string $search * @param int $limit * @param int $offset - * @return array with user ids + * @return array an array of user ids */ public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0); diff --git a/lib/private/group/manager.php b/lib/private/group/manager.php index d31225e3c2e..3eb894a644a 100644 --- a/lib/private/group/manager.php +++ b/lib/private/group/manager.php @@ -165,7 +165,7 @@ class Manager extends PublicEmitter { * @param string $search * @param int $limit * @param int $offset - * @return array with display names (value) and user ids (key) + * @return array an array of display names (value) and user ids (key) */ public function displayNamesInGroup($gid, $search = '', $limit = -1, $offset = 0) { $group = $this->get($gid); diff --git a/lib/private/legacy/appconfig.php b/lib/private/legacy/appconfig.php index cb5cef7e350..209f42ffe38 100644 --- a/lib/private/legacy/appconfig.php +++ b/lib/private/legacy/appconfig.php @@ -35,7 +35,7 @@ class OC_Appconfig { /** * @brief Get all apps using the config - * @return array with app ids + * @return array an array of app ids * * This function returns a list of all apps that have at least one * entry in the appconfig table. @@ -47,7 +47,7 @@ class OC_Appconfig { /** * @brief Get the available keys for an app * @param string $app the app we are looking for - * @return array with key names + * @return array an array of key names * * This function gets all keys of an app. Please note that the values are * not returned. diff --git a/lib/private/legacy/config.php b/lib/private/legacy/config.php index 6c2103179ab..76a53d3f627 100644 --- a/lib/private/legacy/config.php +++ b/lib/private/legacy/config.php @@ -51,7 +51,7 @@ class OC_Config { /** * @brief Lists all available config keys - * @return array with key names + * @return array an array of key names * * This function returns all keys saved in config.php. Please note that it * does not return the values. diff --git a/lib/private/legacy/preferences.php b/lib/private/legacy/preferences.php index fcde12796ca..eed6730a529 100644 --- a/lib/private/legacy/preferences.php +++ b/lib/private/legacy/preferences.php @@ -29,7 +29,7 @@ class OC_Preferences{ public static $object; /** * @brief Get all users using the preferences - * @return array with user ids + * @return array an array of user ids * * This function returns a list of all users that have at least one entry * in the preferences table. @@ -54,7 +54,7 @@ class OC_Preferences{ * @brief Get the available keys for an app * @param string $user user * @param string $app the app we are looking for - * @return array with key names + * @return array an array of key names * * This function gets all keys of an app of an user. Please note that the * values are not returned. diff --git a/lib/private/migrate.php b/lib/private/migrate.php index 5bcc11b061b..2ec9a0978ad 100644 --- a/lib/private/migrate.php +++ b/lib/private/migrate.php @@ -538,7 +538,7 @@ class OC_Migrate{ * @param string $db string path to migration.db * @param $info object of migration info * @param string|null|int $uid uid to use - * @return array of apps with import statuses, or false on failure. + * @return array an array of apps with import statuses, or false on failure. */ public static function importAppData( $db, $info, $uid=null ) { // Check if the db exists diff --git a/lib/private/navigationmanager.php b/lib/private/navigationmanager.php index 1f657b9ad80..d7111af03cf 100644 --- a/lib/private/navigationmanager.php +++ b/lib/private/navigationmanager.php @@ -30,7 +30,7 @@ class NavigationManager implements \OCP\INavigationManager { /** * @brief returns all the added Menu entries - * @return array of the added entries + * @return array an array of the added entries */ public function getAll() { return $this->entries; diff --git a/lib/private/ocsclient.php b/lib/private/ocsclient.php index a08c862b0cb..8b8930df937 100644 --- a/lib/private/ocsclient.php +++ b/lib/private/ocsclient.php @@ -59,7 +59,7 @@ class OC_OCSClient{ /** * @brief Get all the categories from the OCS server - * @return array with category ids + * @return array an array of 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 - * @return array with application data + * @return array an array of 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 - * @return array with application data + * @return array an array of 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 - * @return array with application data + * @return array an array of application data * * This function returns an download url for an applications from the OCS server * @param string $id diff --git a/lib/private/preferences.php b/lib/private/preferences.php index d45e6e77089..3cadb6a2e97 100644 --- a/lib/private/preferences.php +++ b/lib/private/preferences.php @@ -69,7 +69,7 @@ class Preferences { /** * @brief Get all users using the preferences - * @return array with user ids + * @return array an array of user ids * * This function returns a list of all users that have at least one entry * in the preferences table. @@ -125,7 +125,7 @@ class Preferences { * @brief Get the available keys for an app * @param string $user user * @param string $app the app we are looking for - * @return array with key names + * @return array an array of key names * * This function gets all keys of an app of an user. Please note that the * values are not returned. diff --git a/lib/private/preview.php b/lib/private/preview.php index 2964b83c508..941f9f26c6a 100755 --- a/lib/private/preview.php +++ b/lib/private/preview.php @@ -382,7 +382,7 @@ class Preview { /** * @brief get possible bigger thumbnails of the given image * @param int $fileId fileId of the original image - * @return array of paths to bigger thumbnails + * @return array an array of paths to bigger thumbnails */ private function getPossibleThumbnails($fileId) { diff --git a/lib/private/share/mailnotifications.php b/lib/private/share/mailnotifications.php index 4799db52330..5110df0e571 100644 --- a/lib/private/share/mailnotifications.php +++ b/lib/private/share/mailnotifications.php @@ -136,7 +136,7 @@ class MailNotifications { * @param string $filename the shared file * @param string $link link to the shared file * @param int $expiration expiration date (timestamp) - * @return array with the html mail body and the plain text mail body + * @return array an array of the html mail body and the plain text mail body */ private function createMailBody($filename, $link, $expiration) { diff --git a/lib/private/user.php b/lib/private/user.php index bf101a29b99..7f8d7bf263b 100644 --- a/lib/private/user.php +++ b/lib/private/user.php @@ -77,7 +77,7 @@ class OC_User { /** * @brief gets available backends * @deprecated - * @return array of backends + * @return array an array of backends * * Returns the names of all backends. */ @@ -88,7 +88,7 @@ class OC_User { /** * @brief gets used backends * @deprecated - * @return array of backends + * @return array an array of backends * * Returns the names of all used backends. */ @@ -517,7 +517,7 @@ class OC_User { /** * @brief Get a list of all users - * @return array with all uids + * @return array an array of 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 3994c1bb8ff..8d2f0e935de 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 - * @return array with all uids + * @return array an array of 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 - * @return array with all displayNames (value) and the corresponding uids (key) + * @return array an array of 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 d70ccd8ad43..d54b0567a18 100644 --- a/lib/private/user/database.php +++ b/lib/private/user/database.php @@ -149,7 +149,7 @@ class OC_User_Database extends OC_User_Backend { /** * @brief Get a list of all display names - * @return array with all displayNames (value) and the correspondig uids (key) + * @return array an array of all displayNames (value) and the correspondig uids (key) * * Get a list of all display names and user ids. */ @@ -226,7 +226,7 @@ class OC_User_Database extends OC_User_Backend { /** * @brief Get a list of all users - * @return array with all uids + * @return array an array of all uids * * Get a list of all users. */ diff --git a/lib/private/user/interface.php b/lib/private/user/interface.php index eee18aea167..80da765cd9f 100644 --- a/lib/private/user/interface.php +++ b/lib/private/user/interface.php @@ -46,7 +46,7 @@ interface OC_User_Interface { /** * @brief Get a list of all users - * @return array with all uids + * @return array an array of all uids * * Get a list of all users. */ @@ -68,7 +68,7 @@ interface OC_User_Interface { /** * @brief Get a list of all display names - * @return array with all displayNames (value) and the corresponding uids (key) + * @return array an array of all displayNames (value) and the corresponding uids (key) * * Get a list of all display names and user ids. */ diff --git a/lib/private/user/manager.php b/lib/private/user/manager.php index 6f6fd80a8ef..939f99618d1 100644 --- a/lib/private/user/manager.php +++ b/lib/private/user/manager.php @@ -261,7 +261,7 @@ class Manager extends PublicEmitter { /** * returns how many users per backend exist (if supported by backend) * - * @return array with backend class as key and count number as value + * @return array an array of backend class as key and count number as value */ public function countUsers() { $userCountStatistics = array(); diff --git a/lib/private/util.php b/lib/private/util.php index 96d80beb4d1..f3fa7b1f220 100755 --- a/lib/private/util.php +++ b/lib/private/util.php @@ -819,7 +819,7 @@ class OC_Util { * string or array of strings before displaying it on a web page. * * @param string|array of strings - * @return array with sanitized strings or a single sanitized string, depends on the input parameter. + * @return array an array of sanitized strings or a single sanitized string, depends on the input parameter. */ public static function sanitizeHTML( &$value ) { if (is_array($value)) { diff --git a/lib/public/backgroundjob.php b/lib/public/backgroundjob.php index 03b94403b47..1832f766ea3 100644 --- a/lib/public/backgroundjob.php +++ b/lib/public/backgroundjob.php @@ -125,7 +125,7 @@ class BackgroundJob { /** * @deprecated * Gets all queued tasks - * @return array with associative arrays + * @return array an array of associative arrays */ public static function allQueuedTasks() { $jobList = \OC::$server->getJobList(); @@ -145,7 +145,7 @@ class BackgroundJob { * @deprecated * Gets all queued tasks of a specific app * @param string $app app name - * @return array with associative arrays + * @return array an array of associative arrays */ public static function queuedTaskWhereAppIs($app) { $jobList = \OC::$server->getJobList(); diff --git a/lib/public/contacts.php b/lib/public/contacts.php index 1b61d7aa4ff..70c67c75731 100644 --- a/lib/public/contacts.php +++ b/lib/public/contacts.php @@ -87,7 +87,7 @@ namespace OCP { * @param string $pattern which should match within the $searchProperties * @param array $searchProperties defines the properties within the query pattern should match * @param array $options - for future use. One should always have options! - * @return array of contacts which are arrays of key-value-pairs + * @return array an array of contacts which are arrays of key-value-pairs */ public static function search($pattern, $searchProperties = array(), $options = array()) { $cm = \OC::$server->getContactsManager(); @@ -112,7 +112,7 @@ namespace OCP { * * @param array $properties this array if key-value-pairs defines a contact * @param $address_book_key string to identify the address book in which the contact shall be created or updated - * @return array representing the contact just created or updated + * @return array an array representing the contact just created or updated */ public static function createOrUpdate($properties, $address_book_key) { $cm = \OC::$server->getContactsManager(); diff --git a/lib/public/contacts/imanager.php b/lib/public/contacts/imanager.php index 005b71f298b..32559220091 100644 --- a/lib/public/contacts/imanager.php +++ b/lib/public/contacts/imanager.php @@ -88,7 +88,7 @@ namespace OCP\Contacts { * @param string $pattern which should match within the $searchProperties * @param array $searchProperties defines the properties within the query pattern should match * @param array $options - for future use. One should always have options! - * @return array of contacts which are arrays of key-value-pairs + * @return array an array of contacts which are arrays of key-value-pairs */ function search($pattern, $searchProperties = array(), $options = array()); @@ -107,7 +107,7 @@ namespace OCP\Contacts { * * @param array $properties this array if key-value-pairs defines a contact * @param string $address_book_key identifier of the address book in which the contact shall be created or updated - * @return array representing the contact just created or updated + * @return array an array representing the contact just created or updated */ function createOrUpdate($properties, $address_book_key); diff --git a/lib/public/iaddressbook.php b/lib/public/iaddressbook.php index dcfe08012e6..70309e8c57a 100644 --- a/lib/public/iaddressbook.php +++ b/lib/public/iaddressbook.php @@ -45,7 +45,7 @@ namespace OCP { * @param string $pattern which should match within the $searchProperties * @param array $searchProperties defines the properties within the query pattern should match * @param array $options - for future use. One should always have options! - * @return array of contacts which are arrays of key-value-pairs + * @return array an array of contacts which are arrays of key-value-pairs */ public function search($pattern, $searchProperties, $options); // // dummy results @@ -56,7 +56,7 @@ namespace OCP { /** * @param array $properties this array if key-value-pairs defines a contact - * @return array representing the contact just created or updated + * @return array an array representing the contact just created or updated */ public function createOrUpdate($properties); // // dummy diff --git a/lib/public/iappconfig.php b/lib/public/iappconfig.php index 2b014df2e42..16c0752f073 100644 --- a/lib/public/iappconfig.php +++ b/lib/public/iappconfig.php @@ -45,7 +45,7 @@ interface IAppConfig { /** * @brief Get the available keys for an app * @param string $app the app we are looking for - * @return array with key names + * @return array an array of key names * * This function gets all keys of an app. Please note that the values are * not returned. @@ -74,7 +74,7 @@ interface IAppConfig { /** * @brief Get all apps using the config - * @return array with app ids + * @return array an array of app ids * * This function returns a list of all apps that have at least one * entry in the appconfig table. diff --git a/lib/public/user.php b/lib/public/user.php index 7bac938b838..e79ad4e7190 100644 --- a/lib/public/user.php +++ b/lib/public/user.php @@ -48,7 +48,7 @@ class User { * @param string search pattern * @param integer $limit * @param integer $offset - * @return array with all uids + * @return array an array of all uids */ public static function getUsers( $search = '', $limit = null, $offset = null ) { return \OC_User::getUsers( $search, $limit, $offset ); @@ -68,7 +68,7 @@ class User { * @param string search pattern * @param int limit * @param int offset - * @return array with all display names (value) and the correspondig uids (key) + * @return array an array of all display names (value) and the correspondig uids (key) */ public static function getDisplayNames( $search = '', $limit = null, $offset = null ) { return \OC_User::getDisplayNames( $search, $limit, $offset ); diff --git a/lib/public/util.php b/lib/public/util.php index 006a828dca2..0ca6f7928c3 100644 --- a/lib/public/util.php +++ b/lib/public/util.php @@ -381,7 +381,7 @@ class Util { * string or array of strings before displaying it on a web page. * * @param string|array of strings - * @return array with sanitized strings or a single sinitized string, depends on the input parameter. + * @return array an array of sanitized strings or a single sinitized string, depends on the input parameter. */ public static function sanitizeHTML( $value ) { return(\OC_Util::sanitizeHTML($value)); -- cgit v1.2.3 From 87b548ed91c03f051a93cc39bf94650922c1f55f Mon Sep 17 00:00:00 2001 From: Robin McCorkell Date: Sun, 11 May 2014 21:51:30 +0100 Subject: Fix all PHPDoc types and variable names, in /lib --- .../dependencyinjection/dicontainer.php | 4 ++-- lib/private/appframework/http.php | 2 +- lib/private/appframework/routing/routeconfig.php | 12 +++++----- lib/private/archive/tar.php | 2 +- lib/private/avatar.php | 6 ++--- lib/private/avatarmanager.php | 2 +- lib/private/backgroundjob/joblist.php | 8 +++---- lib/private/cache/file.php | 2 +- lib/private/connector/sabre/auth.php | 2 ++ lib/private/connector/sabre/filesplugin.php | 2 +- lib/private/connector/sabre/quotaplugin.php | 2 +- lib/private/db.php | 2 +- lib/private/db/connectionwrapper.php | 4 ++-- lib/private/db/mdb2schemamanager.php | 2 +- lib/private/db/mdb2schemareader.php | 2 +- lib/private/defaults.php | 2 +- lib/private/fileproxy.php | 2 +- lib/private/files/cache/cache.php | 2 +- lib/private/files/cache/scanner.php | 2 +- lib/private/files/filesystem.php | 4 ++-- lib/private/files/mapper.php | 4 ++-- lib/private/files/mount/manager.php | 6 ++--- lib/private/files/node/folder.php | 2 +- lib/private/files/storage/common.php | 4 ++-- lib/private/files/storage/wrapper/quota.php | 2 +- lib/private/geo.php | 4 ++-- lib/private/group.php | 2 +- lib/private/group/dummy.php | 26 ++++++++++---------- lib/private/group/example.php | 28 +++++++++++----------- lib/private/helper.php | 14 +++++------ lib/private/image.php | 2 +- lib/private/installer.php | 4 ++-- lib/private/l10n.php | 2 +- lib/private/l10n/factory.php | 4 ++-- lib/private/migrate.php | 4 ++-- lib/private/migration/content.php | 16 ++++++------- lib/private/ocs.php | 4 ++-- lib/private/ocs/cloud.php | 4 ++-- lib/private/ocs/result.php | 6 ++--- lib/private/ocsclient.php | 2 +- lib/private/preview.php | 10 ++++---- lib/private/response.php | 6 ++--- lib/private/route/route.php | 2 +- lib/private/route/router.php | 2 +- lib/private/share/helper.php | 20 ++++++++-------- lib/private/share/hooks.php | 10 ++++---- lib/private/share/mailnotifications.php | 4 ++-- lib/private/share/searchresultsorter.php | 4 ++-- lib/private/share/share.php | 22 ++++++++--------- lib/private/subadmin.php | 4 ++-- lib/private/tags.php | 2 +- lib/private/template/functions.php | 2 +- lib/private/template/resourcelocator.php | 10 +++----- lib/private/templatelayout.php | 6 ++--- lib/private/urlgenerator.php | 2 +- lib/private/user/database.php | 28 +++++++++++----------- lib/private/user/example.php | 18 +++++++------- lib/private/user/http.php | 8 +++---- lib/private/user/interface.php | 12 ++++------ lib/private/util.php | 10 ++++---- lib/private/vobject.php | 16 ++++++------- lib/public/app.php | 10 ++++---- lib/public/backgroundjob.php | 4 ++-- lib/public/backgroundjob/ijoblist.php | 6 ++--- lib/public/contacts.php | 4 ++-- lib/public/db.php | 2 +- lib/public/iavatar.php | 2 +- lib/public/iavatarmanager.php | 2 +- lib/public/idbconnection.php | 4 ++-- lib/public/il10n.php | 2 +- lib/public/route/iroute.php | 2 +- lib/public/share.php | 24 +++++++++---------- lib/public/template.php | 22 ++++++++--------- lib/public/user.php | 14 +++++------ lib/public/util.php | 16 ++++++------- 75 files changed, 255 insertions(+), 263 deletions(-) (limited to 'lib/private/group.php') diff --git a/lib/private/appframework/dependencyinjection/dicontainer.php b/lib/private/appframework/dependencyinjection/dicontainer.php index 97a6569a0f6..ee492b8a9e5 100644 --- a/lib/private/appframework/dependencyinjection/dicontainer.php +++ b/lib/private/appframework/dependencyinjection/dicontainer.php @@ -190,8 +190,8 @@ class DIContainer extends SimpleContainer implements IAppContainer{ } /** - * @param $message - * @param $level + * @param string $message + * @param string $level * @return mixed */ function log($message, $level) { diff --git a/lib/private/appframework/http.php b/lib/private/appframework/http.php index d09e1d3ce2e..2b1387af715 100644 --- a/lib/private/appframework/http.php +++ b/lib/private/appframework/http.php @@ -33,7 +33,7 @@ class Http extends BaseHttp { protected $headers; /** - * @param $_SERVER $server + * @param array $server $_SERVER * @param string $protocolVersion the http version to use defaults to HTTP/1.1 */ public function __construct($server, $protocolVersion='HTTP/1.1') { diff --git a/lib/private/appframework/routing/routeconfig.php b/lib/private/appframework/routing/routeconfig.php index a3bbde6af53..91ea7778d08 100644 --- a/lib/private/appframework/routing/routeconfig.php +++ b/lib/private/appframework/routing/routeconfig.php @@ -61,7 +61,7 @@ class RouteConfig { /** * Creates one route base on the give configuration - * @param $routes + * @param array $routes * @throws \UnexpectedValueException */ private function processSimpleRoutes($routes) @@ -105,7 +105,7 @@ class RouteConfig { * - update * - destroy * - * @param $routes + * @param array $routes */ private function processResources($routes) { @@ -151,7 +151,7 @@ class RouteConfig { /** * Based on a given route name the controller name is generated - * @param $controller + * @param string $controller * @return string */ private function buildControllerName($controller) @@ -161,7 +161,7 @@ class RouteConfig { /** * Based on the action part of the route name the controller method name is generated - * @param $action + * @param string $action * @return string */ private function buildActionName($action) { @@ -170,7 +170,7 @@ class RouteConfig { /** * Generates the id used in the url part o the route url - * @param $resource + * @param string $resource * @return string */ private function buildResourceId($resource) { @@ -179,7 +179,7 @@ class RouteConfig { /** * Underscored strings are converted to camel case strings - * @param $str string + * @param string $str * @return string */ private function underScoreToCamelCase($str) { diff --git a/lib/private/archive/tar.php b/lib/private/archive/tar.php index cbdb565ba35..21a995d9e50 100644 --- a/lib/private/archive/tar.php +++ b/lib/private/archive/tar.php @@ -154,7 +154,7 @@ class OC_Archive_TAR extends OC_Archive{ } /** * get the last modified time of a file in the archive - * @param string path + * @param string $path * @return int */ function mtime($path) { diff --git a/lib/private/avatar.php b/lib/private/avatar.php index e97f55eecaf..45959798476 100644 --- a/lib/private/avatar.php +++ b/lib/private/avatar.php @@ -16,7 +16,7 @@ class OC_Avatar implements \OCP\IAvatar { /** * @brief constructor - * @param $user string user to do avatar-management with + * @param string $user user to do avatar-management with */ public function __construct ($user) { $this->view = new \OC\Files\View('/'.$user); @@ -24,7 +24,7 @@ class OC_Avatar implements \OCP\IAvatar { /** * @brief get the users avatar - * @param $size integer size in px of the avatar, avatars are square, defaults to 64 + * @param int $size size in px of the avatar, avatars are square, defaults to 64 * @return boolean|\OC_Image containing the avatar or false if there's no image */ public function get ($size = 64) { @@ -44,7 +44,7 @@ class OC_Avatar implements \OCP\IAvatar { /** * @brief sets the users avatar - * @param $data mixed OC_Image, imagedata or path to set a new avatar + * @param \OC_Image|resource|string $data OC_Image, imagedata or path to set a new avatar * @throws Exception if the provided file is not a jpg or png image * @throws Exception if the provided image is not valid * @throws \OC\NotSquareException if the image is not square diff --git a/lib/private/avatarmanager.php b/lib/private/avatarmanager.php index 3ca46868ea6..f462e6ac5fd 100644 --- a/lib/private/avatarmanager.php +++ b/lib/private/avatarmanager.php @@ -17,7 +17,7 @@ class AvatarManager implements IAvatarManager { /** * @brief return a user specific instance of \OCP\IAvatar * @see \OCP\IAvatar - * @param $user string the ownCloud user id + * @param string $user the ownCloud user id * @return \OCP\IAvatar */ function getAvatar($user) { diff --git a/lib/private/backgroundjob/joblist.php b/lib/private/backgroundjob/joblist.php index 26c90269349..9fa13c25851 100644 --- a/lib/private/backgroundjob/joblist.php +++ b/lib/private/backgroundjob/joblist.php @@ -31,7 +31,7 @@ class JobList implements IJobList { } /** - * @param \Test\BackgroundJob\TestJob $job + * @param Job|string $job * @param mixed $argument */ public function add($job, $argument = null) { @@ -48,7 +48,7 @@ class JobList implements IJobList { } /** - * @param Job $job + * @param Job|string $job * @param mixed $argument */ public function remove($job, $argument = null) { @@ -70,7 +70,7 @@ class JobList implements IJobList { /** * check if a job is in the list * - * @param $job + * @param Job|string $job * @param mixed $argument * @return bool */ @@ -126,7 +126,7 @@ class JobList implements IJobList { /** * @param int $id - * @return Job + * @return Job|null */ public function getById($id) { $query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` WHERE `id` = ?'); diff --git a/lib/private/cache/file.php b/lib/private/cache/file.php index feee9cc32b6..4e7c065678e 100644 --- a/lib/private/cache/file.php +++ b/lib/private/cache/file.php @@ -48,7 +48,7 @@ class File { /** * Returns the size of the stored/cached data * - * @param $key + * @param string $key * @return int */ public function size($key) { diff --git a/lib/private/connector/sabre/auth.php b/lib/private/connector/sabre/auth.php index 5577273df8c..9ebf5fc05cf 100644 --- a/lib/private/connector/sabre/auth.php +++ b/lib/private/connector/sabre/auth.php @@ -69,6 +69,8 @@ class OC_Connector_Sabre_Auth extends Sabre_DAV_Auth_Backend_AbstractBasic { * even if there are no HTTP Basic Auth headers. * In other case, just fallback to the parent implementation. * + * @param Sabre_DAV_Server $server + * @param $realm * @return bool */ public function authenticate(Sabre_DAV_Server $server, $realm) { diff --git a/lib/private/connector/sabre/filesplugin.php b/lib/private/connector/sabre/filesplugin.php index 65231040fb5..f8495b40524 100644 --- a/lib/private/connector/sabre/filesplugin.php +++ b/lib/private/connector/sabre/filesplugin.php @@ -73,7 +73,7 @@ class OC_Connector_Sabre_FilesPlugin extends Sabre_DAV_ServerPlugin } /** - * @param $filePath + * @param string $filePath * @param Sabre_DAV_INode $node * @throws Sabre_DAV_Exception_BadRequest */ diff --git a/lib/private/connector/sabre/quotaplugin.php b/lib/private/connector/sabre/quotaplugin.php index 1e73e1645c3..c9b8336b57b 100644 --- a/lib/private/connector/sabre/quotaplugin.php +++ b/lib/private/connector/sabre/quotaplugin.php @@ -97,7 +97,7 @@ class OC_Connector_Sabre_QuotaPlugin extends Sabre_DAV_ServerPlugin { } /** - * @param $parentUri + * @param string $parentUri * @return mixed */ public function getFreeSpace($parentUri) { diff --git a/lib/private/db.php b/lib/private/db.php index 322a13642ae..52bf570d1d0 100644 --- a/lib/private/db.php +++ b/lib/private/db.php @@ -401,7 +401,7 @@ class OC_DB { /** * @brief replaces the ownCloud tables with a new set - * @param $file string path to the MDB2 xml db export file + * @param string $file path to the MDB2 xml db export file */ public static function replaceDB( $file ) { $schemaManager = self::getMDB2SchemaManager(); diff --git a/lib/private/db/connectionwrapper.php b/lib/private/db/connectionwrapper.php index c2cfc21d204..132e76666ab 100644 --- a/lib/private/db/connectionwrapper.php +++ b/lib/private/db/connectionwrapper.php @@ -41,8 +41,8 @@ class ConnectionWrapper implements \OCP\IDBConnection { /** * Insert a row if a matching row doesn't exists. - * @param string The table name (will replace *PREFIX*) to perform the replace on. - * @param array + * @param string $table The table name (will replace *PREFIX*) to perform the replace on. + * @param array $input * * The input array if in the form: * diff --git a/lib/private/db/mdb2schemamanager.php b/lib/private/db/mdb2schemamanager.php index aaf2ea543b9..d98197445e9 100644 --- a/lib/private/db/mdb2schemamanager.php +++ b/lib/private/db/mdb2schemamanager.php @@ -126,7 +126,7 @@ class MDB2SchemaManager { /** * @brief replaces the ownCloud tables with a new set - * @param $file string path to the MDB2 xml db export file + * @param string $file path to the MDB2 xml db export file */ public function replaceDB( $file ) { $apps = \OC_App::getAllApps(); diff --git a/lib/private/db/mdb2schemareader.php b/lib/private/db/mdb2schemareader.php index 0923b6cf1a9..597650985fa 100644 --- a/lib/private/db/mdb2schemareader.php +++ b/lib/private/db/mdb2schemareader.php @@ -66,7 +66,7 @@ class MDB2SchemaReader { } /** - * @param\Doctrine\DBAL\Schema\Schema $schema + * @param \Doctrine\DBAL\Schema\Schema $schema * @param \SimpleXMLElement $xml * @throws \DomainException */ diff --git a/lib/private/defaults.php b/lib/private/defaults.php index fca798568c5..663c327a3b0 100644 --- a/lib/private/defaults.php +++ b/lib/private/defaults.php @@ -185,7 +185,7 @@ class OC_Defaults { /** * Returns mail header color - * @return mail header color + * @return string */ public function getMailHeaderColor() { if ($this->themeExist('getMailHeaderColor')) { diff --git a/lib/private/fileproxy.php b/lib/private/fileproxy.php index 88976c1b8e5..2835e974642 100644 --- a/lib/private/fileproxy.php +++ b/lib/private/fileproxy.php @@ -47,7 +47,7 @@ class OC_FileProxy{ /** * fallback function when a proxy operation is not implemented * @param string $function the name of the proxy operation - * @param mixed + * @param mixed $arguments * * this implements a dummy proxy for all operations */ diff --git a/lib/private/files/cache/cache.php b/lib/private/files/cache/cache.php index 6aab2173da7..3e4f6dfb132 100644 --- a/lib/private/files/cache/cache.php +++ b/lib/private/files/cache/cache.php @@ -640,7 +640,7 @@ class Cache { /** * normalize the given path - * @param $path + * @param string $path * @return string */ public function normalize($path) { diff --git a/lib/private/files/cache/scanner.php b/lib/private/files/cache/scanner.php index 8c2ec057ca7..51454a71458 100644 --- a/lib/private/files/cache/scanner.php +++ b/lib/private/files/cache/scanner.php @@ -273,7 +273,7 @@ class Scanner extends BasicEmitter { * @brief check if the file should be ignored when scanning * NOTE: files with a '.part' extension are ignored as well! * prevents unfinished put requests to be scanned - * @param String $file + * @param string $file * @return boolean */ public static function isPartialFile($file) { diff --git a/lib/private/files/filesystem.php b/lib/private/files/filesystem.php index a4994e4dfb6..22d15840c32 100644 --- a/lib/private/files/filesystem.php +++ b/lib/private/files/filesystem.php @@ -245,7 +245,7 @@ class Filesystem { } /** - * @param $id + * @param string $id * @return Mount\Mount[] */ public static function getMountByStorageId($id) { @@ -256,7 +256,7 @@ class Filesystem { } /** - * @param $id + * @param int $id * @return Mount\Mount[] */ public static function getMountByNumericId($id) { diff --git a/lib/private/files/mapper.php b/lib/private/files/mapper.php index 833d4bd8d1c..666719da12d 100644 --- a/lib/private/files/mapper.php +++ b/lib/private/files/mapper.php @@ -97,8 +97,8 @@ class Mapper } /** - * @param $path - * @param $root + * @param string $path + * @param string $root * @return false|string */ public function stripRootFolder($path, $root) { diff --git a/lib/private/files/mount/manager.php b/lib/private/files/mount/manager.php index 91460b72730..db1f4600c74 100644 --- a/lib/private/files/mount/manager.php +++ b/lib/private/files/mount/manager.php @@ -33,7 +33,7 @@ class Manager { /** * Find the mount for $path * - * @param $path + * @param string $path * @return Mount */ public function find($path) { @@ -61,7 +61,7 @@ class Manager { /** * Find all mounts in $path * - * @param $path + * @param string $path * @return Mount[] */ public function findIn($path) { @@ -112,7 +112,7 @@ class Manager { /** * Find mounts by numeric storage id * - * @param string $id + * @param int $id * @return Mount[] */ public function findByNumericId($id) { diff --git a/lib/private/files/node/folder.php b/lib/private/files/node/folder.php index d9e0ddc2d61..1af34fc2be6 100644 --- a/lib/private/files/node/folder.php +++ b/lib/private/files/node/folder.php @@ -296,7 +296,7 @@ class Folder extends Node implements \OCP\Files\Folder { } /** - * @param $id + * @param int $id * @return \OC\Files\Node\Node[] */ public function getById($id) { diff --git a/lib/private/files/storage/common.php b/lib/private/files/storage/common.php index 8a263d4ce1e..fef33cabd87 100644 --- a/lib/private/files/storage/common.php +++ b/lib/private/files/storage/common.php @@ -317,7 +317,7 @@ abstract class Common implements \OC\Files\Storage\Storage { * clean a path, i.e. remove all redundant '.' and '..' * making sure that it can't point to higher than '/' * - * @param $path The path to clean + * @param string $path The path to clean * @return string cleaned path */ public function cleanPath($path) { @@ -347,7 +347,7 @@ abstract class Common implements \OC\Files\Storage\Storage { /** * get the free space in the storage * - * @param $path + * @param string $path * @return int */ public function free_space($path) { diff --git a/lib/private/files/storage/wrapper/quota.php b/lib/private/files/storage/wrapper/quota.php index a878b2c5cf6..c57c797f87a 100644 --- a/lib/private/files/storage/wrapper/quota.php +++ b/lib/private/files/storage/wrapper/quota.php @@ -30,7 +30,7 @@ class Quota extends Wrapper { } /** - * @return quota value + * @return int quota value */ public function getQuota() { return $this->quota; diff --git a/lib/private/geo.php b/lib/private/geo.php index cd62511f0c1..a0ad2b799ab 100644 --- a/lib/private/geo.php +++ b/lib/private/geo.php @@ -8,8 +8,8 @@ class OC_Geo{ /** * @brief returns the closest timezone to coordinates - * @param $latitude - * @param $longitude + * @param float $latitude + * @param float $longitude * @return mixed Closest timezone */ public static function timezone($latitude, $longitude) { diff --git a/lib/private/group.php b/lib/private/group.php index 5b291d7f2f6..845b3655bab 100644 --- a/lib/private/group.php +++ b/lib/private/group.php @@ -58,7 +58,7 @@ class OC_Group { /** * @brief set the group backend - * @param \OC_Group_Backend $backend The backend to use for user managment + * @param \OC_Group_Backend $backend The backend to use for user managment * @return bool */ public static function useBackend($backend) { diff --git a/lib/private/group/dummy.php b/lib/private/group/dummy.php index 7a766a6b35d..553aae54291 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 - * @return true/false + * @return bool * * Trys to create a new group. If the group name already exists, false will * be returned. @@ -45,8 +45,8 @@ class OC_Group_Dummy extends OC_Group_Backend { /** * @brief delete a group - * @param $gid gid of the group to delete - * @return true/false + * @param string $gid gid of the group to delete + * @return bool * * Deletes a group and removes it from the group_user-table */ @@ -61,9 +61,9 @@ 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 - * @return true/false + * @param string $uid uid of the user + * @param string $gid gid of the group + * @return bool * * Checks whether the user is member of a group or not. */ @@ -77,9 +77,9 @@ 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 - * @return true/false + * @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 * * Adds a user to a group. */ @@ -98,9 +98,9 @@ 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 - * @return true/false + * @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 * * removes the user from a group. */ @@ -118,7 +118,7 @@ class OC_Group_Dummy extends OC_Group_Backend { /** * @brief Get all groups a user belongs to - * @param $uid Name of the user + * @param string $uid Name of the user * @return array an array of group names * * This function fetches all groups a user belongs to. It does not check diff --git a/lib/private/group/example.php b/lib/private/group/example.php index 12be5421c1c..cfcc0d245d1 100644 --- a/lib/private/group/example.php +++ b/lib/private/group/example.php @@ -28,8 +28,8 @@ abstract class OC_Group_Example { /** * @brief Try to create a new group - * @param $gid The name of the group to create - * @return true/false + * @param string $gid The name of the group to create + * @return bool * * Trys to create a new group. If the group name already exists, false will * be returned. @@ -38,8 +38,8 @@ abstract class OC_Group_Example { /** * @brief delete a group - * @param $gid gid of the group to delete - * @return true/false + * @param string $gid gid of the group to delete + * @return bool * * Deletes a group and removes it from the group_user-table */ @@ -47,9 +47,9 @@ abstract class OC_Group_Example { /** * @brief is user in group? - * @param $uid uid of the user - * @param $gid gid of the group - * @return true/false + * @param string $uid uid of the user + * @param string $gid gid of the group + * @return bool * * Checks whether the user is member of a group or not. */ @@ -57,9 +57,9 @@ 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 - * @return true/false + * @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 * * Adds a user to a group. */ @@ -67,9 +67,9 @@ 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 - * @return true/false + * @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 * * removes the user from a group. */ @@ -77,7 +77,7 @@ abstract class OC_Group_Example { /** * @brief Get all groups a user belongs to - * @param $uid Name of the user + * @param string $uid Name of the user * @return array an array of group names * * This function fetches all groups a user belongs to. It does not check diff --git a/lib/private/helper.php b/lib/private/helper.php index ae957846082..12d82f6fb45 100644 --- a/lib/private/helper.php +++ b/lib/private/helper.php @@ -32,7 +32,7 @@ class OC_Helper { /** * @brief Creates an url using a defined route - * @param $route + * @param string $route * @param array $parameters * @return * @internal param array $args with param=>value, will be appended to the returned url @@ -495,7 +495,7 @@ class OC_Helper { /** * detect if a given program is found in the search PATH * - * @param $name + * @param string $name * @param bool $path * @internal param string $program name * @internal param string $optional search path, defaults to $PATH @@ -670,8 +670,8 @@ class OC_Helper { /** * Adds a suffix to the name in case the file exists * - * @param $path - * @param $filename + * @param string $path + * @param string $filename * @return string */ public static function buildNotExistingFileName($path, $filename) { @@ -682,8 +682,8 @@ class OC_Helper { /** * Adds a suffix to the name in case the file exists * - * @param $path - * @param $filename + * @param string $path + * @param string $filename * @return string */ public static function buildNotExistingFileNameForView($path, $filename, \OC\Files\View $view) { @@ -775,7 +775,7 @@ class OC_Helper { /** * @brief replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement. * - * @param $string + * @param string $string * @param string $replacement The replacement string. * @param int $start If start is positive, the replacing will begin at the start'th offset into string. If start is negative, the replacing will begin at the start'th character from the end of string. * @param int $length Length of the part to be replaced diff --git a/lib/private/image.php b/lib/private/image.php index 14aa64d12da..341bfaaf818 100644 --- a/lib/private/image.php +++ b/lib/private/image.php @@ -424,7 +424,7 @@ class OC_Image { * @brief Loads an image from an open file handle. * It is the responsibility of the caller to position the pointer at the correct place and to close the handle again. * @param resource $handle - * @return An image resource or false on error + * @return resource|false An image resource or false on error */ public function loadFromFileHandle($handle) { OC_Log::write('core', __METHOD__.'(): Trying', OC_Log::DEBUG); diff --git a/lib/private/installer.php b/lib/private/installer.php index d7d43779d92..9417c32bc89 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 - * @return true/false + * @return bool * * Checks whether or not an app is installed, i.e. registered in apps table. */ @@ -313,7 +313,7 @@ class OC_Installer{ /** * @brief Removes an app * @param string $name name of the application to remove - * @param $options array with options + * @param array $options options * @return boolean|null * * This function removes an app. $options is an associative array. The diff --git a/lib/private/l10n.php b/lib/private/l10n.php index 9ab60e871d0..c9d9e8131b1 100644 --- a/lib/private/l10n.php +++ b/lib/private/l10n.php @@ -183,7 +183,7 @@ class OC_L10N implements \OCP\IL10N { * * Parts of the code is copied from Habari: * https://github.com/habari/system/blob/master/classes/locale.php - * @param $string string + * @param string $string * @return string */ protected function createPluralFormFunction($string){ diff --git a/lib/private/l10n/factory.php b/lib/private/l10n/factory.php index 8c65f368171..d0c3799b9c2 100644 --- a/lib/private/l10n/factory.php +++ b/lib/private/l10n/factory.php @@ -20,8 +20,8 @@ class Factory { /** * get an L10N instance - * @param $app string - * @param $lang string|null + * @param string $app + * @param string|null $lang * @return \OC_L10N */ public function get($app) { diff --git a/lib/private/migrate.php b/lib/private/migrate.php index 2ec9a0978ad..98c825aafd8 100644 --- a/lib/private/migrate.php +++ b/lib/private/migrate.php @@ -333,7 +333,7 @@ class OC_Migrate{ /** * @brief tries to extract the import zip - * @param $path string path to the zip + * @param string $path path to the zip * @return string path to extract location (with a trailing slash) or false on failure */ static private function extractZip( $path ) { @@ -536,7 +536,7 @@ class OC_Migrate{ /** * @brief imports a new user * @param string $db string path to migration.db - * @param $info object of migration info + * @param object $info object of migration info * @param string|null|int $uid uid to use * @return array an array of apps with import statuses, or false on failure. */ diff --git a/lib/private/migration/content.php b/lib/private/migration/content.php index b0e7a4e9528..d3b2fe836a4 100644 --- a/lib/private/migration/content.php +++ b/lib/private/migration/content.php @@ -35,7 +35,7 @@ class OC_Migration_Content{ /** * @brief sets up the * @param ZipArchive $zip ZipArchive object - * @param $db a database object (required for exporttype user) + * @param object $db a database object (required for exporttype user) * @return bool|null */ public function __construct( $zip, $db=null ) { @@ -45,11 +45,9 @@ class OC_Migration_Content{ } - // @brief prepares the db - // @param $query the sql query to prepare - /** - * @param string $query + * @brief prepares the db + * @param string $query the sql query to prepare */ public function prepare( $query ) { @@ -88,7 +86,7 @@ class OC_Migration_Content{ /** * @brief copys rows to migration.db from the main database - * @param $options array of options. + * @param array $options array of options. * @return bool */ public function copyRows( $options ) { @@ -131,7 +129,7 @@ class OC_Migration_Content{ /** * @brief saves a sql data set into migration.db * @param OC_DB_StatementWrapper $data a sql data set returned from self::prepare()->query() - * @param $options array of copyRows options + * @param array $options array of copyRows options * @return void */ private function insertData( $data, $options ) { @@ -170,8 +168,8 @@ class OC_Migration_Content{ /** * @brief adds a directory to the zip object * @param boolean|string $dir string path of the directory to add - * @param $recursive bool - * @param $internaldir string path of folder to add dir to in zip + * @param bool $recursive + * @param string $internaldir path of folder to add dir to in zip * @return bool */ public function addDir( $dir, $recursive=true, $internaldir='' ) { diff --git a/lib/private/ocs.php b/lib/private/ocs.php index 211e8222145..aeb3d259b30 100644 --- a/lib/private/ocs.php +++ b/lib/private/ocs.php @@ -213,8 +213,8 @@ class OC_OCS { } /** - * @param $writer - * @param $data + * @param resource $writer + * @param array $data * @param string $node */ public static function toXml($writer, $data, $node) { diff --git a/lib/private/ocs/cloud.php b/lib/private/ocs/cloud.php index c8bb9425f1a..3ced0af8ee1 100644 --- a/lib/private/ocs/cloud.php +++ b/lib/private/ocs/cloud.php @@ -57,8 +57,8 @@ class OC_OCS_Cloud { * * * - * @param $parameters object should contain parameter 'userid' which identifies - * the user from whom the information will be returned + * @param array $parameters should contain parameter 'userid' which identifies + * the user from whom the information will be returned */ public static function getUser($parameters) { $return = array(); diff --git a/lib/private/ocs/result.php b/lib/private/ocs/result.php index 0e3b85d5905..567fe7f87fe 100644 --- a/lib/private/ocs/result.php +++ b/lib/private/ocs/result.php @@ -26,7 +26,7 @@ class OC_OCS_Result{ /** * create the OCS_Result object - * @param $data mixed the data to return + * @param mixed $data the data to return */ public function __construct($data=null, $code=100, $message=null) { if ($data === null) { @@ -42,7 +42,7 @@ class OC_OCS_Result{ /** * optionally set the total number of items available - * @param $items int + * @param int $items */ public function setTotalItems(int $items) { $this->items = $items; @@ -50,7 +50,7 @@ class OC_OCS_Result{ /** * optionally set the the number of items per page - * @param $items int + * @param int $items */ public function setItemsPerPage(int $items) { $this->perPage = $items; diff --git a/lib/private/ocsclient.php b/lib/private/ocsclient.php index 8b8930df937..fb8282747eb 100644 --- a/lib/private/ocsclient.php +++ b/lib/private/ocsclient.php @@ -95,7 +95,7 @@ class OC_OCSClient{ * @return array an array of application data * * This function returns a list of all the applications on the OCS server - * @param $categories + * @param array|string $categories * @param int $page * @param string $filter */ diff --git a/lib/private/preview.php b/lib/private/preview.php index 941f9f26c6a..bf8c04e0998 100755 --- a/lib/private/preview.php +++ b/lib/private/preview.php @@ -191,7 +191,7 @@ class Preview { /** * @brief set the path of the file you want a thumbnail from * @param string $file - * @return $this + * @return object $this */ public function setFile($file) { $this->file = $file; @@ -217,7 +217,7 @@ class Preview { * @brief set the the max width of the preview * @param int $maxX * @throws \Exception - * @return $this + * @return \OC\Preview $this */ public function setMaxX($maxX = 1) { if ($maxX <= 0) { @@ -238,7 +238,7 @@ class Preview { * @brief set the the max height of the preview * @param int $maxY * @throws \Exception - * @return $this + * @return \OC\Preview $this */ public function setMaxY($maxY = 1) { if ($maxY <= 0) { @@ -258,7 +258,7 @@ class Preview { /** * @brief set whether or not scalingup is enabled * @param bool $scalingUp - * @return $this + * @return \OC\Preview $this */ public function setScalingup($scalingUp) { if ($this->getMaxScaleFactor() === 1) { @@ -750,7 +750,7 @@ class Preview { } /** - * @param $fileId + * @param int $fileId * @return string */ private function buildCachePath($fileId) { diff --git a/lib/private/response.php b/lib/private/response.php index 4905c0a787b..f976925fb2e 100644 --- a/lib/private/response.php +++ b/lib/private/response.php @@ -93,7 +93,7 @@ class OC_Response { /** * @brief Set reponse expire time - * @param $expires date-time when the response expires + * @param string|DateTime $expires date-time when the response expires * string for DateInterval from now * DateTime object when to expire response */ @@ -113,7 +113,7 @@ class OC_Response { /** * Checks and set ETag header, when the request matches sends a * 'not modified' response - * @param $etag token to use for modification check + * @param string $etag token to use for modification check */ static public function setETagHeader($etag) { if (empty($etag)) { @@ -131,7 +131,7 @@ class OC_Response { /** * Checks and set Last-Modified header, when the request matches sends a * 'not modified' response - * @param $lastModified time when the reponse was last modified + * @param int|DateTime|string $lastModified time when the reponse was last modified */ static public function setLastModifiedHeader($lastModified) { if (empty($lastModified)) { diff --git a/lib/private/route/route.php b/lib/private/route/route.php index df80facf9c1..87030ad7853 100644 --- a/lib/private/route/route.php +++ b/lib/private/route/route.php @@ -124,7 +124,7 @@ class Route extends SymfonyRoute implements IRoute { /** * The action to execute when this route matches, includes a file like * it is called directly - * @param $file + * @param string $file * @return void */ public function actionInclude($file) { diff --git a/lib/private/route/router.php b/lib/private/route/router.php index 44b0b941508..a72ac2bb3f1 100644 --- a/lib/private/route/router.php +++ b/lib/private/route/router.php @@ -239,7 +239,7 @@ class Router implements IRouter { /** * To isolate the variable scope used inside the $file it is required in it's own method - * @param $file + * @param string $file */ private function requireRouteFile($file) { require_once $file; diff --git a/lib/private/share/helper.php b/lib/private/share/helper.php index 515ec85909a..68f4a35af19 100644 --- a/lib/private/share/helper.php +++ b/lib/private/share/helper.php @@ -25,13 +25,13 @@ class Helper extends \OC\Share\Constants { /** * Generate a unique target for the item - * @param string Item type - * @param string Item source - * @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK - * @param string User or group the item is being shared with - * @param string User that is the owner of shared item - * @param string The suggested target originating from a reshare (optional) - * @param int The id of the parent group share (optional) + * @param string $itemType + * @param string $itemSource + * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK + * @param string $shareWith User or group the item is being shared with + * @param string $uidOwner User that is the owner of shared item + * @param string $suggestedTarget The suggested target originating from a reshare (optional) + * @param int $groupParent The id of the parent group share (optional) * @return string Item target */ public static function generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner, @@ -142,9 +142,9 @@ class Helper extends \OC\Share\Constants { /** * Delete all reshares of an item - * @param int Id of item to delete - * @param bool If true, exclude the parent from the delete (optional) - * @param string The user that the parent was shared with (optinal) + * @param int $parent Id of item to delete + * @param bool $excludeParent If true, exclude the parent from the delete (optional) + * @param string $uidOwner The user that the parent was shared with (optinal) */ public static function delete($parent, $excludeParent = false, $uidOwner = null) { $ids = array($parent); diff --git a/lib/private/share/hooks.php b/lib/private/share/hooks.php index a33c71eedd2..9ac64d888ea 100644 --- a/lib/private/share/hooks.php +++ b/lib/private/share/hooks.php @@ -22,9 +22,9 @@ namespace OC\Share; class Hooks extends \OC\Share\Constants { - /** + /** * Function that is called after a user is deleted. Cleans up the shares of that user. - * @param array arguments + * @param array $arguments */ public static function post_deleteUser($arguments) { // Delete any items shared with the deleted user @@ -42,7 +42,7 @@ class Hooks extends \OC\Share\Constants { /** * Function that is called after a user is added to a group. * TODO what does it do? - * @param array arguments + * @param array $arguments */ public static function post_addToGroup($arguments) { // Find the group shares and check if the user needs a unique target @@ -76,7 +76,7 @@ class Hooks extends \OC\Share\Constants { /** * Function that is called after a user is removed from a group. Shares are cleaned up. - * @param array arguments + * @param array $arguments */ public static function post_removeFromGroup($arguments) { $sql = 'SELECT `id`, `share_type` FROM `*PREFIX*share`' @@ -95,7 +95,7 @@ class Hooks extends \OC\Share\Constants { /** * Function that is called after a group is removed. Cleans up the shares to that group. - * @param array arguments + * @param array $arguments */ public static function post_deleteGroup($arguments) { $sql = 'SELECT `id` FROM `*PREFIX*share` WHERE `share_type` = ? AND `share_with` = ?'; diff --git a/lib/private/share/mailnotifications.php b/lib/private/share/mailnotifications.php index 5110df0e571..0cd36e97d54 100644 --- a/lib/private/share/mailnotifications.php +++ b/lib/private/share/mailnotifications.php @@ -50,8 +50,8 @@ class MailNotifications { * @brief inform users if a file was shared with them * * @param array $recipientList list of recipients - * @param type $itemSource shared item source - * @param type $itemType shared item type + * @param string $itemSource shared item source + * @param string $itemType shared item type * @return array list of user to whom the mail send operation failed */ public function sendInternalShareMail($recipientList, $itemSource, $itemType) { diff --git a/lib/private/share/searchresultsorter.php b/lib/private/share/searchresultsorter.php index 76abbf30846..91709902fff 100644 --- a/lib/private/share/searchresultsorter.php +++ b/lib/private/share/searchresultsorter.php @@ -18,8 +18,8 @@ class SearchResultSorter { * @param string $search the search term as was given by the user * @param string $key the array key containing the value that should be compared * against - * @param $encoding optional, encoding to use, defaults to UTF-8 - * @param $log optional, an \OC\Log instance + * @param string $encoding optional, encoding to use, defaults to UTF-8 + * @param \OC\Log $log optional */ public function __construct($search, $key, \OC\Log $log = null, $encoding = 'UTF-8') { $this->encoding = $encoding; diff --git a/lib/private/share/share.php b/lib/private/share/share.php index 211c7e7cb1c..98275a59a6f 100644 --- a/lib/private/share/share.php +++ b/lib/private/share/share.php @@ -254,12 +254,12 @@ class Share extends \OC\Share\Constants { /** * Get the items of item type shared with a user - * @param string Item type - * @param sting user id for which user we want the shares - * @param int Format (optional) Format type must be defined by the backend - * @param mixed Parameters (optional) - * @param int Number of items to return (optional) Returns all by default - * @param boolean include collections (optional) + * @param string $itemType + * @param string $user id for which user we want the shares + * @param int $format (optional) Format type must be defined by the backend + * @param mixed $parameters (optional) + * @param int $limit Number of items to return (optional) Returns all by default + * @param boolean $includeCollections (optional) * @return Return depends on format */ public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE, @@ -388,8 +388,8 @@ class Share extends \OC\Share\Constants { /** * resolves reshares down to the last real share - * @param $linkItem - * @return $fileOwner + * @param array $linkItem + * @return array file owner */ public static function resolveReShare($linkItem) { @@ -446,7 +446,7 @@ class Share extends \OC\Share\Constants { * @param string $uidOwner * @param boolean $includeCollections * @param boolean $checkExpireDate - * @return Return array of users + * @return array Return array of users */ public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) { @@ -1000,10 +1000,10 @@ class Share extends \OC\Share\Constants { /** * Get shared items from the database * @param string $itemType - * @param string Item source or target (optional) + * @param string $item Item source or target (optional) * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, SHARE_TYPE_LINK, $shareTypeUserAndGroups, or $shareTypeGroupUserUnique * @param string $shareWith User or group the item is being shared with - * @param string uidOwner User that is the owner of shared items (optional) + * @param string $uidOwner User that is the owner of shared items (optional) * @param int $format Format to convert items to with formatItems() (optional) * @param mixed $parameters to pass to formatItems() (optional) * @param int $limit Number of items to return, -1 to return all matches (optional) diff --git a/lib/private/subadmin.php b/lib/private/subadmin.php index 5b6072987ad..3e8b73d55b0 100644 --- a/lib/private/subadmin.php +++ b/lib/private/subadmin.php @@ -167,7 +167,7 @@ class OC_SubAdmin{ /** * @brief delete all SubAdmins by uid - * @param $parameters + * @param array $parameters * @return boolean */ public static function post_deleteUser($parameters) { @@ -178,7 +178,7 @@ class OC_SubAdmin{ /** * @brief delete all SubAdmins by gid - * @param $parameters + * @param array $parameters * @return boolean */ public static function post_deleteGroup($parameters) { diff --git a/lib/private/tags.php b/lib/private/tags.php index 2e786e3fd7b..0b62caf2dd8 100644 --- a/lib/private/tags.php +++ b/lib/private/tags.php @@ -393,7 +393,7 @@ class Tags implements \OCP\ITags { * * For hooking up on post_deleteUser * - * @param array + * @param array $arguments */ public static function post_deleteUser($arguments) { // Find all objectid/tagId pairs. diff --git a/lib/private/template/functions.php b/lib/private/template/functions.php index 0a32dc48f22..3f5312c0a7b 100644 --- a/lib/private/template/functions.php +++ b/lib/private/template/functions.php @@ -70,7 +70,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 + * @param string $path path of file * @return link to the preview * * For further information have a look at OC_Helper::previewIcon diff --git a/lib/private/template/resourcelocator.php b/lib/private/template/resourcelocator.php index 8a3dd5e7fa9..900aa6a8f08 100644 --- a/lib/private/template/resourcelocator.php +++ b/lib/private/template/resourcelocator.php @@ -53,13 +53,9 @@ abstract class ResourceLocator { /* * @brief append the $file resource if exist at $root - * @param $root path to check - * @param $file the filename - * @param $web base for path, default map $root to $webroot - */ - /** - * @param string $file - * @param string|false $webroot + * @param string $root path to check + * @param string $file the filename + * @param string|null $webroot base for path, default map $root to $webroot */ protected function appendIfExist($root, $file, $webroot = null) { if (is_file($root.'/'.$file)) { diff --git a/lib/private/templatelayout.php b/lib/private/templatelayout.php index b7ac02a753d..0672ffc4a3d 100644 --- a/lib/private/templatelayout.php +++ b/lib/private/templatelayout.php @@ -98,7 +98,7 @@ class OC_TemplateLayout extends OC_Template { } /** - * @param $styles + * @param array $styles * @return array */ static public function findStylesheetFiles($styles) { @@ -116,7 +116,7 @@ class OC_TemplateLayout extends OC_Template { } /** - * @param $scripts + * @param array $scripts * @return array */ static public function findJavascriptFiles($scripts) { @@ -175,7 +175,7 @@ class OC_TemplateLayout extends OC_Template { } /** - * @param $files + * @param array $files * @return string */ private static function hashScriptNames($files) diff --git a/lib/private/urlgenerator.php b/lib/private/urlgenerator.php index a56b0fe3378..b37ef89d40d 100644 --- a/lib/private/urlgenerator.php +++ b/lib/private/urlgenerator.php @@ -30,7 +30,7 @@ class URLGenerator implements IURLGenerator { /** * @brief Creates an url using a defined route - * @param $route + * @param string $route * @param array $parameters * @internal param array $args with param=>value, will be appended to the returned url * @return string the url 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); diff --git a/lib/private/util.php b/lib/private/util.php index f3fa7b1f220..1c3177af435 100755 --- a/lib/private/util.php +++ b/lib/private/util.php @@ -818,8 +818,8 @@ class OC_Util { * This function is used to sanitize HTML and should be applied on any * string or array of strings before displaying it on a web page. * - * @param string|array of strings - * @return array an array of sanitized strings or a single sanitized string, depends on the input parameter. + * @param string|array &$value + * @return string|array an array of sanitized strings or a single sanitized string, depends on the input parameter. */ public static function sanitizeHTML( &$value ) { if (is_array($value)) { @@ -1028,8 +1028,8 @@ class OC_Util { /** * @brief Generates a cryptographic secure pseudo-random string - * @param Int $length of the random string - * @return String + * @param int $length of the random string + * @return string * Please also update secureRNGAvailable if you change something here */ public static function generateRandomBytes($length = 30) { @@ -1287,7 +1287,7 @@ class OC_Util { /** * Returns whether the given file name is valid - * @param $file string file name to check + * @param string $file file name to check * @return bool true if the file name is valid, false otherwise */ public static function isValidFileName($file) { diff --git a/lib/private/vobject.php b/lib/private/vobject.php index 20cacd926ba..cb556e07c9e 100644 --- a/lib/private/vobject.php +++ b/lib/private/vobject.php @@ -89,7 +89,7 @@ class OC_VObject{ /** * Constructor - * @param Sabre\VObject\Component or string + * @param Sabre\VObject\Component|string $vobject_or_name */ public function __construct($vobject_or_name) { if (is_object($vobject_or_name)) { @@ -101,7 +101,7 @@ class OC_VObject{ /** * @todo Write documentation - * @param $item + * @param \OC_VObject|\Sabre\VObject\Component $item * @param null $itemValue */ public function add($item, $itemValue = null) { @@ -138,7 +138,7 @@ class OC_VObject{ /** * @todo Write documentation - * @param mixed $name + * @param mixed $name * @param string $string */ public function setString($name, $string) { @@ -175,7 +175,7 @@ class OC_VObject{ /** * @todo Write documentation - * @param $name + * @param string $name * @return string */ public function getAsString($name) { @@ -186,7 +186,7 @@ class OC_VObject{ /** * @todo Write documentation - * @param $name + * @param string $name * @return array */ public function getAsArray($name) { @@ -200,7 +200,7 @@ class OC_VObject{ /** * @todo Write documentation - * @param $name + * @param string $name * @return array|OC_VObject|\Sabre\VObject\Property */ public function &__get($name) { @@ -242,8 +242,8 @@ class OC_VObject{ /** * @todo Write documentation - * @param $function - * @param $arguments + * @param callable $function + * @param array $arguments * @return mixed */ public function __call($function, $arguments) { diff --git a/lib/public/app.php b/lib/public/app.php index 96162299ec4..bef4e96ae02 100644 --- a/lib/public/app.php +++ b/lib/public/app.php @@ -36,7 +36,7 @@ namespace OCP; class App { /** * Makes ownCloud aware of this app - * @param array with all information + * @param array $data with all information * @return boolean * * @deprecated This method is deprecated. Do not call it anymore. @@ -49,7 +49,7 @@ class App { /** * Adds an entry to the navigation - * @param array containing the data + * @param array $data containing the data * @return boolean * * This function adds a new entry to the navigation visible to users. $data @@ -70,7 +70,7 @@ class App { /** * Marks a navigation entry as active - * @param string id of the entry + * @param string $id id of the entry * @return boolean * * This function sets a navigation entry as active and removes the 'active' @@ -83,8 +83,8 @@ class App { /** * Register a Configuration Screen that should appear in the personal settings section. - * @param $app string appid - * @param $page string page to be included + * @param string $app appid + * @param string $page page to be included * @return void */ public static function registerPersonal( $app, $page ) { diff --git a/lib/public/backgroundjob.php b/lib/public/backgroundjob.php index 1832f766ea3..562228e1e52 100644 --- a/lib/public/backgroundjob.php +++ b/lib/public/backgroundjob.php @@ -94,7 +94,7 @@ class BackgroundJob { /** * @deprecated * gets all regular tasks - * @return associative array + * @return array * * key is string "$klass-$method", value is array( $klass, $method ) */ @@ -115,7 +115,7 @@ class BackgroundJob { * @deprecated * Gets one queued task * @param int $id ID of the task - * @return BackgroundJob\IJob array + * @return BackgroundJob\IJob|null */ public static function findQueuedTask($id) { $jobList = \OC::$server->getJobList(); diff --git a/lib/public/backgroundjob/ijoblist.php b/lib/public/backgroundjob/ijoblist.php index c9b546605b8..366b0e37368 100644 --- a/lib/public/backgroundjob/ijoblist.php +++ b/lib/public/backgroundjob/ijoblist.php @@ -12,7 +12,7 @@ interface IJobList { /** * Add a job to the list * - * @param \OCP\BackgroundJob\IJob |string $job + * @param \OCP\BackgroundJob\IJob|string $job * @param mixed $argument The argument to be passed to $job->run() when the job is exectured * @param string $job * @return void @@ -22,7 +22,7 @@ interface IJobList { /** * Remove a job from the list * - * @param IJob $job + * @param \OCP\BackgroundJob\IJob|string $job * @param mixed $argument * @return void */ @@ -31,7 +31,7 @@ interface IJobList { /** * check if a job is in the list * - * @param $job + * @param \OCP\BackgroundJob\IJob|string $job * @param mixed $argument * @return bool */ diff --git a/lib/public/contacts.php b/lib/public/contacts.php index 70c67c75731..0d12e91c67f 100644 --- a/lib/public/contacts.php +++ b/lib/public/contacts.php @@ -98,7 +98,7 @@ namespace OCP { * This function can be used to delete the contact identified by the given id * * @param object $id the unique identifier to a contact - * @param $address_book_key + * @param string $address_book_key * @return bool successful or not */ public static function delete($id, $address_book_key) { @@ -111,7 +111,7 @@ namespace OCP { * Otherwise the contact will be updated by replacing the entire data set. * * @param array $properties this array if key-value-pairs defines a contact - * @param $address_book_key string to identify the address book in which the contact shall be created or updated + * @param string $address_book_key identifier of the address book in which the contact shall be created or updated * @return array an array representing the contact just created or updated */ public static function createOrUpdate($properties, $address_book_key) { diff --git a/lib/public/db.php b/lib/public/db.php index cb876b4d1f9..ba3a4724ce0 100644 --- a/lib/public/db.php +++ b/lib/public/db.php @@ -50,7 +50,7 @@ class DB { /** * Insert a row if a matching row doesn't exists. * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix - * @param $input array + * @param array $input * * The input array if in the form: * diff --git a/lib/public/iavatar.php b/lib/public/iavatar.php index 43fa32556de..fc7e8e79fed 100644 --- a/lib/public/iavatar.php +++ b/lib/public/iavatar.php @@ -15,7 +15,7 @@ interface IAvatar { /** * @brief get the users avatar - * @param $size integer size in px of the avatar, avatars are square, defaults to 64 + * @param int $size size in px of the avatar, avatars are square, defaults to 64 * @return boolean|\OC_Image containing the avatar or false if there's no image */ function get($size = 64); diff --git a/lib/public/iavatarmanager.php b/lib/public/iavatarmanager.php index 9b185ae0467..b09b456a0da 100644 --- a/lib/public/iavatarmanager.php +++ b/lib/public/iavatarmanager.php @@ -16,7 +16,7 @@ interface IAvatarManager { /** * @brief return a user specific instance of \OCP\IAvatar * @see \OCP\IAvatar - * @param $user string the ownCloud user id + * @param string $user the ownCloud user id * @return \OCP\IAvatar */ function getAvatar($user); diff --git a/lib/public/idbconnection.php b/lib/public/idbconnection.php index 656b5e7e5b2..3e6624e07e9 100644 --- a/lib/public/idbconnection.php +++ b/lib/public/idbconnection.php @@ -52,8 +52,8 @@ interface IDBConnection { /** * Insert a row if a matching row doesn't exists. - * @param string The table name (will replace *PREFIX*) to perform the replace on. - * @param array + * @param string $table The table name (will replace *PREFIX*) to perform the replace on. + * @param array $input * * The input array if in the form: * diff --git a/lib/public/il10n.php b/lib/public/il10n.php index 1388274c21a..c228be6a0a3 100644 --- a/lib/public/il10n.php +++ b/lib/public/il10n.php @@ -53,7 +53,7 @@ interface IL10N { * Localization * @param string $type Type of localization * @param array $data parameters for this localization - * @return String or false + * @return string|false * * Returns the localized data. * diff --git a/lib/public/route/iroute.php b/lib/public/route/iroute.php index d5610e762a8..f511e7af720 100644 --- a/lib/public/route/iroute.php +++ b/lib/public/route/iroute.php @@ -26,7 +26,7 @@ interface IRoute { * The action to execute when this route matches, includes a file like * it is called directly * - * @param $file + * @param string $file * @return void */ public function actionInclude($file); diff --git a/lib/public/share.php b/lib/public/share.php index 018386253bc..33c5069ac57 100644 --- a/lib/public/share.php +++ b/lib/public/share.php @@ -92,13 +92,13 @@ class Share extends \OC\Share\Constants { /** * Get the items of item type shared with a user - * @param string Item type - * @param sting user id for which user we want the shares - * @param int Format (optional) Format type must be defined by the backend - * @param mixed Parameters (optional) - * @param int Number of items to return (optional) Returns all by default - * @param bool include collections (optional) - * @return Return depends on format + * @param string $itemType + * @param string $user for which user we want the shares + * @param int $format (optional) Format type must be defined by the backend + * @param mixed $parameters (optional) + * @param int $limit Number of items to return (optional) Returns all by default + * @param bool $includeCollections (optional) + * @return mixed Return depends on format */ public static function getItemsSharedWithUser($itemType, $user, $format = self::FORMAT_NONE, $parameters = null, $limit = -1, $includeCollections = false) { @@ -111,8 +111,8 @@ class Share extends \OC\Share\Constants { * @param string $itemType * @param string $itemTarget * @param int $format (optional) Format type must be defined by the backend - * @param mixed Parameters (optional) - * @param bool include collections (optional) + * @param mixed $parameters (optional) + * @param bool $includeCollections (optional) * @return mixed Return depends on format */ public static function getItemSharedWith($itemType, $itemTarget, $format = self::FORMAT_NONE, @@ -168,8 +168,8 @@ class Share extends \OC\Share\Constants { /** * resolves reshares down to the last real share - * @param $linkItem - * @return $fileOwner + * @param array $linkItem + * @return array file owner */ public static function resolveReShare($linkItem) { return \OC\Share\Share::resolveReShare($linkItem); @@ -213,7 +213,7 @@ class Share extends \OC\Share\Constants { * @param string $uidOwner * @param bool $includeCollections * @param bool $checkExpireDate - * @return Return array of users + * @return array Return array of users */ public static function getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections = false, $checkExpireDate = true) { return \OC\Share\Share::getUsersItemShared($itemType, $itemSource, $uidOwner, $includeCollections, $checkExpireDate); diff --git a/lib/public/template.php b/lib/public/template.php index 6cc984b12d5..b1264e0c3ad 100644 --- a/lib/public/template.php +++ b/lib/public/template.php @@ -33,8 +33,8 @@ namespace OCP; /** * Make OC_Helper::imagePath available as a simple function - * @param string app - * @param string image + * @param string $app + * @param string $image * @return string to the image * * @see OC_Helper::imagePath @@ -46,7 +46,7 @@ function image_path( $app, $image ) { /** * Make OC_Helper::mimetypeIcon available as a simple function - * @param string mimetype + * @param string $mimetype * @return string to the image of this file type. */ function mimetype_icon( $mimetype ) { @@ -55,7 +55,7 @@ function mimetype_icon( $mimetype ) { /** * Make preview_icon available as a simple function - * @param string path of file + * @param string $path path to file * @return string to the preview of the image */ function preview_icon( $path ) { @@ -76,7 +76,7 @@ function publicPreview_icon ( $path, $token ) { /** * Make OC_Helper::humanFileSize available as a simple function * Example: 2048 to 2 kB. - * @param int size in bytes + * @param int $size in bytes * @return string size as string */ function human_file_size( $bytes ) { @@ -86,8 +86,8 @@ function human_file_size( $bytes ) { /** * Return the relative date in relation to today. Returns something like "last hour" or "two month ago" - * @param int unix timestamp - * @param boolean date only + * @param int $timestamp unix timestamp + * @param boolean $dateOnly * @return OC_L10N_String human readable interpretation of the timestamp */ function relative_modified_date( $timestamp, $dateOnly = false ) { @@ -98,7 +98,7 @@ function relative_modified_date( $timestamp, $dateOnly = false ) { /** * Return a human readable outout for a file size. * @deprecated human_file_size() instead - * @param integer size of a file in byte + * @param integer $bytes size of a file in byte * @return string human readable interpretation of a file size */ function simple_file_size($bytes) { @@ -108,9 +108,9 @@ function simple_file_size($bytes) { /** * Generate html code for an options block. - * @param $options the options - * @param $selected which one is selected? - * @param array the parameters + * @param array $options the options + * @param mixed $selected which one is selected? + * @param array $params the parameters * @return string html options */ function html_select_options($options, $selected, $params=array()) { diff --git a/lib/public/user.php b/lib/public/user.php index e79ad4e7190..925410d37d5 100644 --- a/lib/public/user.php +++ b/lib/public/user.php @@ -45,9 +45,9 @@ class User { /** * Get a list of all users - * @param string search pattern - * @param integer $limit - * @param integer $offset + * @param string $search search pattern + * @param int|null $limit + * @param int|null $offset * @return array an array of all uids */ public static function getUsers( $search = '', $limit = null, $offset = null ) { @@ -56,7 +56,7 @@ class User { /** * Get the user display name of the user currently logged in. - * @param string user id or null for current user + * @param string|null $user user id or null for current user * @return string display name */ public static function getDisplayName( $user = null ) { @@ -65,9 +65,9 @@ class User { /** * Get a list of all display names and user ids. - * @param string search pattern - * @param int limit - * @param int offset + * @param string $search search pattern + * @param int|null $limit + * @param int|null $offset * @return array an array of all display names (value) and the correspondig uids (key) */ public static function getDisplayNames( $search = '', $limit = null, $offset = null ) { diff --git a/lib/public/util.php b/lib/public/util.php index 0ca6f7928c3..8aeb03aef8e 100644 --- a/lib/public/util.php +++ b/lib/public/util.php @@ -203,7 +203,7 @@ class Util { /** * Creates an url using a defined route - * @param $route + * @param string $route * @param array $parameters * @internal param array $args with param=>value, will be appended to the returned url * @return string the url @@ -380,8 +380,8 @@ class Util { * This function is used to sanitize HTML and should be applied on any * string or array of strings before displaying it on a web page. * - * @param string|array of strings - * @return array an array of sanitized strings or a single sinitized string, depends on the input parameter. + * @param string|array $value + * @return string|array an array of sanitized strings or a single sinitized string, depends on the input parameter. */ public static function sanitizeHTML( $value ) { return(\OC_Util::sanitizeHTML($value)); @@ -458,7 +458,7 @@ class Util { * * @param string $dir the current folder where the user currently operates * @param int $free the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly - * @return number of bytes representing + * @return int number of bytes representing */ public static function maxUploadFilesize($dir, $free = null) { return \OC_Helper::maxUploadFilesize($dir, $free); @@ -476,7 +476,7 @@ class Util { /** * Calculate PHP upload limit * - * @return number of bytes representing + * @return int number of bytes representing */ public static function uploadLimit() { return \OC_Helper::uploadLimit(); @@ -484,7 +484,7 @@ class Util { /** * Returns whether the given file name is valid - * @param $file string file name to check + * @param string $file file name to check * @return bool true if the file name is valid, false otherwise */ public static function isValidFileName($file) { @@ -493,8 +493,8 @@ class Util { /** * @brief Generates a cryptographic secure pseudo-random string - * @param Int $length of the random string - * @return String + * @param int $length of the random string + * @return string */ public static function generateRandomBytes($length = 30) { return \OC_Util::generateRandomBytes($length); -- cgit v1.2.3