From: Matthias Schmidt <gravatronics@live.com>
Date: Tue, 10 May 2016 20:16:09 +0000 (+0200)
Subject: Update documentation of IHistorySavingObjectTypeProvider::checkPermissions()
X-Git-Tag: 3.0.0_Beta_1~1743
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=b366a4ea041bf3eb0dc41a0baeb81d956bb75485;p=GitHub%2FWoltLab%2FWCF.git

Update documentation of IHistorySavingObjectTypeProvider::checkPermissions()
---

diff --git a/wcfsetup/install/files/lib/system/edit/IHistorySavingObjectTypeProvider.class.php b/wcfsetup/install/files/lib/system/edit/IHistorySavingObjectTypeProvider.class.php
index 3c0290c73b..e1cde99145 100644
--- a/wcfsetup/install/files/lib/system/edit/IHistorySavingObjectTypeProvider.class.php
+++ b/wcfsetup/install/files/lib/system/edit/IHistorySavingObjectTypeProvider.class.php
@@ -1,6 +1,7 @@
 <?php
 namespace wcf\system\edit;
 use wcf\data\object\type\IObjectTypeProvider;
+use wcf\system\exception\PermissionDeniedException;
 
 /**
  * Represents an object which edit history can be saved.
@@ -14,13 +15,12 @@ use wcf\data\object\type\IObjectTypeProvider;
  */
 interface IHistorySavingObjectTypeProvider extends IObjectTypeProvider {
 	/**
-	 * Checks the permissions to review the edit history
-	 * and to revert to an older version of the given
-	 * IHistorySavingObject.
-	 * You must throw a \wcf\system\exception\PermissionDeniedException
-	 * to deny access!
+	 * Checks the permissions to review the edit history and to revert to an
+	 * older version of the given IHistorySavingObject.
 	 * 
-	 * @param	\wcf\system\edit\IHistorySavingObject	$object
+	 * @param	IHistorySavingObject	$object
+	 * @throws	PermissionDeniedException	if access is denied
+	 * @throws	\InvalidArgumentException	if given object has not be provided by this provider and thus cannot be checked by this method
 	 */
 	public function checkPermissions(IHistorySavingObject $object);