[Pkg-owncloud-commits] [owncloud] 101/172: Fix @return array PHPDocs, in /lib
David Prévot
taffit at moszumanska.debian.org
Sun May 18 20:09:45 UTC 2014
This is an automated email from the git hooks/post-receive script.
taffit pushed a commit to branch master
in repository owncloud.
commit b5bc37d2e40aba0ab8d3e72e7f7075352839096d
Author: Robin McCorkell <rmccorkell at karoshi.org.uk>
Date: Sun May 11 18:13:51 2014 +0100
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(-)
diff --git a/lib/private/app.php b/lib/private/app.php
index 2f55b54..a35248f 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 0cd6b3b..5fba751 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 6701ca0..2320db9 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 4299d88..26264d4 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 c4f03b4..e857d45 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 c0bdde0..8c2ec05 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 199ce5d..95f77a8 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 52df1be..a4994e4 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 39c71cf..d3772e2 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 3191de5..5b291d7 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 cc61fce..c1de99b 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 df0d84d..abdf09a 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 37987f2..1ef81c6 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 bcd6f81..12be542 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 4ef3663..74d288d 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 d31225e..3eb894a 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 cb5cef7..209f42f 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 6c21031..76a53d3 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 fcde127..eed6730 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 5bcc11b..2ec9a09 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 1f657b9a..d7111af 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 a08c862..8b8930d 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 d45e6e7..3cadb6a 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 2964b83..941f9f2 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 4799db5..5110df0 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 bf101a2..7f8d7bf 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 3994c1b..8d2f0e9 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 d70ccd8..d54b056 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 eee18ae..80da765 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 6f6fd80..939f996 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 96d80be..f3fa7b1 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 03b9440..1832f76 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 1b61d7a..70c67c7 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 005b71f..3255922 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 dcfe080..70309e8 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 2b014df..16c0752 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 7bac938..e79ad4e 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 006a828..0ca6f79 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));
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud.git
More information about the Pkg-owncloud-commits
mailing list