From cd205249e4deb397235dde90e707135fcc85d878 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Mon, 3 Aug 2015 15:46:23 +0200 Subject: more phpdoc --- lib/private/lock/abstractlockingprovider.php | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/private/lock/abstractlockingprovider.php b/lib/private/lock/abstractlockingprovider.php index 03b4912ea13..c9c3e08994e 100644 --- a/lib/private/lock/abstractlockingprovider.php +++ b/lib/private/lock/abstractlockingprovider.php @@ -23,6 +23,10 @@ namespace OC\Lock; use OCP\Lock\ILockingProvider; +/** + * Base locking provider that keeps track of locks acquired during the current request + * to release any left over locks at the end of the request + */ abstract class AbstractLockingProvider implements ILockingProvider { protected $acquiredLocks = [ 'shared' => [], @@ -30,6 +34,8 @@ abstract class AbstractLockingProvider implements ILockingProvider { ]; /** + * Mark a locally acquired lock + * * @param string $path * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE */ @@ -45,6 +51,8 @@ abstract class AbstractLockingProvider implements ILockingProvider { } /** + * Mark a release of a locally acquired lock + * * @param string $path * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE */ @@ -59,7 +67,7 @@ abstract class AbstractLockingProvider implements ILockingProvider { } /** - * Change the type of an existing lock + * Change the type of an existing tracked lock * * @param string $path * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE -- cgit v1.2.3