diff options
author | Thomas Müller <thomas.mueller@tmit.eu> | 2014-05-13 23:23:11 +0200 |
---|---|---|
committer | Thomas Müller <thomas.mueller@tmit.eu> | 2014-05-13 23:23:11 +0200 |
commit | 5fb94bf76f199a4dc713fe6e37e683d1d908e972 (patch) | |
tree | 7d2e456d6618c0674556ba8089b1a047df090f6f /lib/private/share/helper.php | |
parent | 401bc60981f3a5da967ee7aa26662b46f0502aa0 (diff) | |
parent | 37ba6f503abfdd0f24ac515d1c71aa4a705a211f (diff) | |
download | nextcloud-server-5fb94bf76f199a4dc713fe6e37e683d1d908e972.tar.gz nextcloud-server-5fb94bf76f199a4dc713fe6e37e683d1d908e972.zip |
Merge pull request #8542 from owncloud/phpdoc-improvements
PHPDoc Improvements
Diffstat (limited to 'lib/private/share/helper.php')
-rw-r--r-- | lib/private/share/helper.php | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/lib/private/share/helper.php b/lib/private/share/helper.php index 515ec85909a..bc83d569840 100644 --- a/lib/private/share/helper.php +++ b/lib/private/share/helper.php @@ -25,13 +25,14 @@ 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) + * @throws \Exception * @return string Item target */ public static function generateTarget($itemType, $itemSource, $shareType, $shareWith, $uidOwner, @@ -142,9 +143,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 (optional) */ public static function delete($parent, $excludeParent = false, $uidOwner = null) { $ids = array($parent); |