From 0c9604e3b2b44885647e2bc2edda95329fddbf47 Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Fri, 5 Jun 2015 17:30:45 +0200 Subject: [OCP] update PHPdoc to contain correct @since tags --- lib/public/lock/ilockingprovider.php | 17 +++++++++++++++++ lib/public/lock/lockedexception.php | 8 ++++++++ 2 files changed, 25 insertions(+) (limited to 'lib/public/lock') diff --git a/lib/public/lock/ilockingprovider.php b/lib/public/lock/ilockingprovider.php index 6a963b9d7aa..fd2aa615452 100644 --- a/lib/public/lock/ilockingprovider.php +++ b/lib/public/lock/ilockingprovider.php @@ -21,14 +21,27 @@ namespace OCP\Lock; +/** + * Interface ILockingProvider + * + * @package OCP\Lock + * @since 8.1.0 + */ interface ILockingProvider { + /** + * @since 8.1.0 + */ const LOCK_SHARED = 1; + /** + * @since 8.1.0 + */ const LOCK_EXCLUSIVE = 2; /** * @param string $path * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE * @return bool + * @since 8.1.0 */ public function isLocked($path, $type); @@ -36,12 +49,14 @@ interface ILockingProvider { * @param string $path * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE * @throws \OCP\Lock\LockedException + * @since 8.1.0 */ public function acquireLock($path, $type); /** * @param string $path * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE + * @since 8.1.0 */ public function releaseLock($path, $type); @@ -51,11 +66,13 @@ interface ILockingProvider { * @param string $path * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE * @throws \OCP\Lock\LockedException + * @since 8.1.0 */ public function changeLock($path, $targetType); /** * release all lock acquired by this instance + * @since 8.1.0 */ public function releaseAll(); } diff --git a/lib/public/lock/lockedexception.php b/lib/public/lock/lockedexception.php index 87f7164b7e0..f8a0221f10b 100644 --- a/lib/public/lock/lockedexception.php +++ b/lib/public/lock/lockedexception.php @@ -21,6 +21,12 @@ namespace OCP\Lock; +/** + * Class LockedException + * + * @package OCP\Lock + * @since 8.1.0 + */ class LockedException extends \Exception { /** * @var string @@ -31,6 +37,7 @@ class LockedException extends \Exception { * LockedException constructor. * * @param string $path + * @since 8.1.0 */ public function __construct($path) { parent::__construct($path . ' is locked'); @@ -39,6 +46,7 @@ class LockedException extends \Exception { /** * @return string + * @since 8.1.0 */ public function getPath() { return $this->path; -- cgit v1.2.3