summaryrefslogtreecommitdiffstats
path: root/lib/public
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2015-02-10 01:14:00 +0100
committerMorris Jobke <hey@morrisjobke.de>2015-02-10 01:14:00 +0100
commit1bb6de7c1b7d25c67bafaa3d6a37d0e0cec0b169 (patch)
tree360da574039aa66cf91c6731a6b80e1da7afffc3 /lib/public
parent4a99849c6c444a656c17b0e1f82dead6fb60cc5c (diff)
parent2b99fc76eced32c740a9f87d48354e0ffdc57f45 (diff)
downloadnextcloud-server-1bb6de7c1b7d25c67bafaa3d6a37d0e0cec0b169.tar.gz
nextcloud-server-1bb6de7c1b7d25c67bafaa3d6a37d0e0cec0b169.zip
Merge pull request #13425 from owncloud/phpdoc_cleanup
Cleanup of PHPDoc return types
Diffstat (limited to 'lib/public')
-rw-r--r--lib/public/files/storage.php30
-rw-r--r--lib/public/iappconfig.php2
-rw-r--r--lib/public/itags.php6
-rw-r--r--lib/public/share_backend.php2
4 files changed, 20 insertions, 20 deletions
diff --git a/lib/public/files/storage.php b/lib/public/files/storage.php
index 36d5b800df6..3e6559c28f7 100644
--- a/lib/public/files/storage.php
+++ b/lib/public/files/storage.php
@@ -72,7 +72,7 @@ interface Storage {
* see http://php.net/manual/en/function.opendir.php
*
* @param string $path
- * @return resource
+ * @return resource|false
*/
public function opendir($path);
@@ -97,7 +97,7 @@ interface Storage {
* only the following keys are required in the result: size and mtime
*
* @param string $path
- * @return array
+ * @return array|false
*/
public function stat($path);
@@ -105,7 +105,7 @@ interface Storage {
* see http://php.net/manual/en/function.filetype.php
*
* @param string $path
- * @return bool
+ * @return string|false
*/
public function filetype($path);
@@ -114,7 +114,7 @@ interface Storage {
* The result for filesize when called on a folder is required to be 0
*
* @param string $path
- * @return int
+ * @return int|false
*/
public function filesize($path);
@@ -179,7 +179,7 @@ interface Storage {
* see http://php.net/manual/en/function.filemtime.php
*
* @param string $path
- * @return int
+ * @return int|false
*/
public function filemtime($path);
@@ -187,7 +187,7 @@ interface Storage {
* see http://php.net/manual/en/function.file_get_contents.php
*
* @param string $path
- * @return string
+ * @return string|false
*/
public function file_get_contents($path);
@@ -231,7 +231,7 @@ interface Storage {
*
* @param string $path
* @param string $mode
- * @return resource
+ * @return resource|false
*/
public function fopen($path, $mode);
@@ -240,7 +240,7 @@ interface Storage {
* The mimetype for a folder is required to be "httpd/unix-directory"
*
* @param string $path
- * @return string
+ * @return string|false
*/
public function getMimeType($path);
@@ -250,7 +250,7 @@ interface Storage {
* @param string $type
* @param string $path
* @param bool $raw
- * @return string
+ * @return string|false
*/
public function hash($type, $path, $raw = false);
@@ -258,7 +258,7 @@ interface Storage {
* see http://php.net/manual/en/function.free_space.php
*
* @param string $path
- * @return int
+ * @return int|false
*/
public function free_space($path);
@@ -266,7 +266,7 @@ interface Storage {
* search for occurrences of $query in file names
*
* @param string $query
- * @return array
+ * @return array|false
*/
public function search($query);
@@ -285,7 +285,7 @@ interface Storage {
* The local version of the file can be temporary and doesn't have to be persistent across requests
*
* @param string $path
- * @return string
+ * @return string|false
*/
public function getLocalFile($path);
@@ -294,7 +294,7 @@ interface Storage {
* The local version of the folder can be temporary and doesn't have to be persistent across requests
*
* @param string $path
- * @return string
+ * @return string|false
*/
public function getLocalFolder($path);
/**
@@ -313,7 +313,7 @@ interface Storage {
* get the ETag for a file or folder
*
* @param string $path
- * @return string
+ * @return string|false
*/
public function getETag($path);
@@ -342,7 +342,7 @@ interface Storage {
* For now the returned array can hold the parameter url - in future more attributes might follow.
*
* @param string $path
- * @return array
+ * @return array|false
*/
public function getDirectDownload($path);
}
diff --git a/lib/public/iappconfig.php b/lib/public/iappconfig.php
index cbd1a7e0573..3a976b4a263 100644
--- a/lib/public/iappconfig.php
+++ b/lib/public/iappconfig.php
@@ -58,7 +58,7 @@ interface IAppConfig {
*
* @param string|false $key
* @param string|false $app
- * @return array
+ * @return array|false
*/
public function getValues($app, $key);
diff --git a/lib/public/itags.php b/lib/public/itags.php
index 238b12c6424..ec6da9eb512 100644
--- a/lib/public/itags.php
+++ b/lib/public/itags.php
@@ -97,7 +97,7 @@ interface ITags {
* Throws an exception if the tag could not be found.
*
* @param string|integer $tag Tag id or name.
- * @return array An array of object ids or false on error.
+ * @return array|false An array of object ids or false on error.
*/
public function getIdsForTag($tag);
@@ -123,7 +123,7 @@ interface ITags {
* Add a new tag.
*
* @param string $name A string with a name of the tag
- * @return int the id of the added tag or false if it already exists.
+ * @return int|false the id of the added tag or false if it already exists.
*/
public function add($name);
@@ -158,7 +158,7 @@ interface ITags {
/**
* Get favorites for an object type
*
- * @return array An array of object ids.
+ * @return array|false An array of object ids.
*/
public function getFavorites();
diff --git a/lib/public/share_backend.php b/lib/public/share_backend.php
index 1ae63d4c1db..0062648d82c 100644
--- a/lib/public/share_backend.php
+++ b/lib/public/share_backend.php
@@ -46,7 +46,7 @@ interface Share_Backend {
* Converts the shared item sources back into the item in the specified format
* @param array $items Shared items
* @param int $format
- * @return TODO
+ * @return array
*
* The items array is a 3-dimensional array with the item_source as the
* first key and the share id as the second key to an array with the share