summaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
authorRobin McCorkell <rmccorkell@karoshi.org.uk>2014-05-11 18:13:51 +0100
committerRobin McCorkell <rmccorkell@karoshi.org.uk>2014-05-13 19:08:14 +0100
commitb5bc37d2e40aba0ab8d3e72e7f7075352839096d (patch)
tree75763a2a8452bd1ab6486fed74994cb207310ece /lib/public
parentb653ad164b83afbc07d7a82d2e4461dace28ba6a (diff)
downloadnextcloud-server-b5bc37d2e40aba0ab8d3e72e7f7075352839096d.tar.gz
nextcloud-server-b5bc37d2e40aba0ab8d3e72e7f7075352839096d.zip
Fix @return array PHPDocs, in /lib
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/backgroundjob.php4
-rw-r--r--lib/public/contacts.php4
-rw-r--r--lib/public/contacts/imanager.php4
-rw-r--r--lib/public/iaddressbook.php4
-rw-r--r--lib/public/iappconfig.php4
-rw-r--r--lib/public/user.php4
-rw-r--r--lib/public/util.php2
7 files changed, 13 insertions, 13 deletions
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));