summaryrefslogtreecommitdiffstats
path: root/apps/files_sharing
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
committerMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
commitdc36d3095314db8d88c2ec1005d99af595c119da (patch)
tree9de515019d7ebae43a545e5dc4eb522ef71dbe9c /apps/files_sharing
parent95741f3936501e3ad6aeb26f93eeb28f9decc273 (diff)
downloadnextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.tar.gz
nextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.zip
Remove all occurences of @brief and @returns from PHPDoc
* test case added to avoid adding them later
Diffstat (limited to 'apps/files_sharing')
-rw-r--r--apps/files_sharing/lib/api.php26
-rw-r--r--apps/files_sharing/lib/cache.php2
-rw-r--r--apps/files_sharing/lib/helper.php2
-rw-r--r--apps/files_sharing/lib/share/file.php4
-rw-r--r--apps/files_sharing/lib/sharedstorage.php28
-rw-r--r--apps/files_sharing/lib/updater.php4
-rw-r--r--apps/files_sharing/tests/api.php14
-rw-r--r--apps/files_sharing/tests/base.php2
-rw-r--r--apps/files_sharing/tests/cache.php2
9 files changed, 42 insertions, 42 deletions
diff --git a/apps/files_sharing/lib/api.php b/apps/files_sharing/lib/api.php
index 5749836bed1..21fd5d00a4c 100644
--- a/apps/files_sharing/lib/api.php
+++ b/apps/files_sharing/lib/api.php
@@ -25,7 +25,7 @@ namespace OCA\Files\Share;
class Api {
/**
- * @brief get all shares
+ * get all shares
*
* @param array $params option 'file' to limit the result to a specific file/folder
* @return \OC_OCS_Result share information
@@ -60,7 +60,7 @@ class Api {
}
/**
- * @brief get share information for a given share
+ * get share information for a given share
*
* @param array $params which contains a 'id'
* @return \OC_OCS_Result share information
@@ -76,7 +76,7 @@ class Api {
}
/**
- * @brief collect all share information, either of a specific share or all
+ * collect all share information, either of a specific share or all
* shares for a given path
* @param array $params
* @return \OC_OCS_Result
@@ -130,7 +130,7 @@ class Api {
}
/**
- * @brief add reshares to a array of shares
+ * add reshares to a array of shares
* @param array $shares array of shares
* @param int $itemSource item source ID
* @return array new shares array which includes reshares
@@ -161,7 +161,7 @@ class Api {
}
/**
- * @brief get share from all files in a given folder (non-recursive)
+ * get share from all files in a given folder (non-recursive)
* @param array $params contains 'path' to the folder
* @return \OC_OCS_Result
*/
@@ -196,7 +196,7 @@ class Api {
}
/**
- * @brief create a new share
+ * create a new share
* @param array $params
* @return \OC_OCS_Result
*/
@@ -313,7 +313,7 @@ class Api {
}
/**
- * @brief update permissions for a share
+ * update permissions for a share
* @param array $share information about the share
* @param array $params contains 'permissions'
* @return \OC_OCS_Result
@@ -358,7 +358,7 @@ class Api {
}
/**
- * @brief enable/disable public upload
+ * enable/disable public upload
* @param array $share information about the share
* @param array $params contains 'publicUpload' which can be 'yes' or 'no'
* @return \OC_OCS_Result
@@ -384,7 +384,7 @@ class Api {
}
/**
- * @brief update password for public link share
+ * update password for public link share
* @param array $share information about the share
* @param array $params 'password'
* @return \OC_OCS_Result
@@ -438,7 +438,7 @@ class Api {
}
/**
- * @brief unshare a file/folder
+ * unshare a file/folder
* @param array $params contains the shareID 'id' which should be unshared
* @return \OC_OCS_Result
*/
@@ -478,7 +478,7 @@ class Api {
}
/**
- * @brief get file ID from a given path
+ * get file ID from a given path
* @param string $path
* @return string fileID or null
*/
@@ -495,7 +495,7 @@ class Api {
}
/**
- * @brief get itemType
+ * get itemType
* @param string $path
* @return string type 'file', 'folder' or null of file/folder doesn't exists
*/
@@ -513,7 +513,7 @@ class Api {
}
/**
- * @brief get some information from a given share
+ * get some information from a given share
* @param int $shareID
* @return array with: item_source, share_type, share_with, item_type, permissions
*/
diff --git a/apps/files_sharing/lib/cache.php b/apps/files_sharing/lib/cache.php
index f793c19307d..9d83ed13b87 100644
--- a/apps/files_sharing/lib/cache.php
+++ b/apps/files_sharing/lib/cache.php
@@ -42,7 +42,7 @@ class Shared_Cache extends Cache {
}
/**
- * @brief Get the source cache of a shared file or folder
+ * Get the source cache of a shared file or folder
* @param string $target Shared target file path
* @return \OC\Files\Cache\Cache
*/
diff --git a/apps/files_sharing/lib/helper.php b/apps/files_sharing/lib/helper.php
index dd4056b48f1..71b496ab944 100644
--- a/apps/files_sharing/lib/helper.php
+++ b/apps/files_sharing/lib/helper.php
@@ -162,7 +162,7 @@ class Helper {
}
/**
- * @brief Format a path to be relative to the /user/files/ directory
+ * Format a path to be relative to the /user/files/ directory
* @param string $path the absolute path
* @return string e.g. turns '/admin/files/test.txt' into 'test.txt'
*/
diff --git a/apps/files_sharing/lib/share/file.php b/apps/files_sharing/lib/share/file.php
index 9950b4d61fd..af71786b104 100644
--- a/apps/files_sharing/lib/share/file.php
+++ b/apps/files_sharing/lib/share/file.php
@@ -54,7 +54,7 @@ class OC_Share_Backend_File implements OCP\Share_Backend_File_Dependent {
}
/**
- * @brief create unique target
+ * create unique target
* @param string $filePath
* @param string $shareWith
* @param string $exclude
@@ -154,7 +154,7 @@ class OC_Share_Backend_File implements OCP\Share_Backend_File_Dependent {
}
/**
- * @brief resolve reshares to return the correct source item
+ * resolve reshares to return the correct source item
* @param array $source
* @return array source item
*/
diff --git a/apps/files_sharing/lib/sharedstorage.php b/apps/files_sharing/lib/sharedstorage.php
index a6a34d9adc0..4b69276d05a 100644
--- a/apps/files_sharing/lib/sharedstorage.php
+++ b/apps/files_sharing/lib/sharedstorage.php
@@ -36,7 +36,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief get id of the mount point
+ * get id of the mount point
* @return string
*/
public function getId() {
@@ -44,7 +44,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief get file cache of the shared item source
+ * get file cache of the shared item source
* @return string
*/
public function getSourceId() {
@@ -52,7 +52,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief Get the source file path, permissions, and owner for a shared file
+ * Get the source file path, permissions, and owner for a shared file
* @param string $target Shared target file path
* @return Returns array with the keys path, permissions, and owner or false if not found
*/
@@ -75,7 +75,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief Get the source file path for a shared file
+ * Get the source file path for a shared file
* @param string $target Shared target file path
* @return string source file path or false if not found
*/
@@ -98,7 +98,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief Get the permissions granted for a shared file
+ * Get the permissions granted for a shared file
* @param string $target Shared target file path
* @return int CRUDS permissions granted
*/
@@ -263,7 +263,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief Format a path to be relative to the /user/files/ directory
+ * Format a path to be relative to the /user/files/ directory
* @param string $path the absolute path
* @return string e.g. turns '/admin/files/test.txt' into '/test.txt'
*/
@@ -287,7 +287,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief rename a shared folder/file
+ * rename a shared folder/file
* @param string $sourcePath
* @param string $targetPath
* @return bool
@@ -481,7 +481,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief return mount point of share, relative to data/user/files
+ * return mount point of share, relative to data/user/files
* @return string
*/
public function getMountPoint() {
@@ -489,7 +489,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief get share type
+ * get share type
* @return integer can be single user share (0) group share (1), unique group share name (2)
*/
private function getShareType() {
@@ -501,7 +501,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief does the group share already has a user specific unique name
+ * does the group share already has a user specific unique name
* @return bool
*/
private function uniqueNameSet() {
@@ -509,14 +509,14 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief the share now uses a unique name of this user
+ * the share now uses a unique name of this user
*/
private function setUniqueName() {
$this->share['unique_name'] = true;
}
/**
- * @brief get share ID
+ * get share ID
* @return integer unique share ID
*/
private function getShareId() {
@@ -524,7 +524,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief get the user who shared the file
+ * get the user who shared the file
* @return string
*/
public function getSharedFrom() {
@@ -532,7 +532,7 @@ class Shared extends \OC\Files\Storage\Common {
}
/**
- * @brief return share type, can be "file" or "folder"
+ * return share type, can be "file" or "folder"
* @return string
*/
public function getItemType() {
diff --git a/apps/files_sharing/lib/updater.php b/apps/files_sharing/lib/updater.php
index 49044383df5..21d67caad9d 100644
--- a/apps/files_sharing/lib/updater.php
+++ b/apps/files_sharing/lib/updater.php
@@ -27,7 +27,7 @@ class Shared_Updater {
static private $toRemove = array();
/**
- * @brief walk up the users file tree and update the etags
+ * walk up the users file tree and update the etags
* @param string $user
* @param string $path
*/
@@ -78,7 +78,7 @@ class Shared_Updater {
}
/**
- * @brief remove all shares for a given file if the file was deleted
+ * remove all shares for a given file if the file was deleted
*
* @param string $path
*/
diff --git a/apps/files_sharing/tests/api.php b/apps/files_sharing/tests/api.php
index 615eacc7186..dc07c6fc620 100644
--- a/apps/files_sharing/tests/api.php
+++ b/apps/files_sharing/tests/api.php
@@ -352,7 +352,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base {
}
/**
- * @brief share a folder, than reshare a file within the shared folder and check if we construct the correct path
+ * share a folder, than reshare a file within the shared folder and check if we construct the correct path
* @medium
*/
function testGetShareFromFolderReshares() {
@@ -417,7 +417,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base {
}
/**
- * @brief reshare a sub folder and check if we get the correct path
+ * reshare a sub folder and check if we get the correct path
* @medium
*/
function testGetShareFromSubFolderReShares() {
@@ -470,7 +470,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base {
}
/**
- * @brief test re-re-share of folder if the path gets constructed correctly
+ * test re-re-share of folder if the path gets constructed correctly
* @medium
*/
function testGetShareFromFolderReReShares() {
@@ -538,7 +538,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base {
}
/**
- * @brief test multiple shared folder if the path gets constructed correctly
+ * test multiple shared folder if the path gets constructed correctly
* @medium
*/
function testGetShareMultipleSharedFolder() {
@@ -621,7 +621,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base {
}
/**
- * @brief test re-re-share of folder if the path gets constructed correctly
+ * test re-re-share of folder if the path gets constructed correctly
* @medium
*/
function testGetShareFromFileReReShares() {
@@ -895,7 +895,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base {
}
/**
- * @brief test unshare of a reshared file
+ * test unshare of a reshared file
*/
function testDeleteReshare() {
@@ -939,7 +939,7 @@ class Test_Files_Sharing_Api extends Test_Files_Sharing_Base {
}
/**
- * @brief share a folder which contains a share mount point, should be forbidden
+ * share a folder which contains a share mount point, should be forbidden
*/
public function testShareFolderWithAMountPoint() {
// user 1 shares a folder with user2
diff --git a/apps/files_sharing/tests/base.php b/apps/files_sharing/tests/base.php
index 27f9419810c..7cd36b9d419 100644
--- a/apps/files_sharing/tests/base.php
+++ b/apps/files_sharing/tests/base.php
@@ -119,7 +119,7 @@ abstract class Test_Files_Sharing_Base extends \PHPUnit_Framework_TestCase {
}
/**
- * @brief get some information from a given share
+ * get some information from a given share
* @param int $shareID
* @return array with: item_source, share_type, share_with, item_type, permissions
*/
diff --git a/apps/files_sharing/tests/cache.php b/apps/files_sharing/tests/cache.php
index 4e63a1844c6..c5408ba55e7 100644
--- a/apps/files_sharing/tests/cache.php
+++ b/apps/files_sharing/tests/cache.php
@@ -230,7 +230,7 @@ class Test_Files_Sharing_Cache extends Test_Files_Sharing_Base {
}
/**
- * @brief verify if each value from the result matches the expected result
+ * verify if each value from the result matches the expected result
* @param array $example array with the expected results
* @param array $result array with the results
*/