From: Siebrand Mazeland <s.mazeland@xs4all.nl>
Date: Sun, 17 Nov 2013 19:04:13 +0000 (+0100)
Subject: Update documentation for ApiDelete::deleteFile()
X-Git-Tag: 1.31.0-rc.0~18078
X-Git-Url: http://git.cyclocoop.org/%22.%28%24lien.?a=commitdiff_plain;h=54dd80cc2f6ccefad173d3f06b0ef7894b5dc75e;p=lhc%2Fweb%2Fwiklou.git

Update documentation for ApiDelete::deleteFile()

WikiPage was no longer valid given the current type hint. Added
types and documentation where missing.

Change-Id: Ie0a3a8fff3ad496b723958133867df48a695d3b7
---

diff --git a/includes/api/ApiDelete.php b/includes/api/ApiDelete.php
index 21264bcbb1..fe5a196902 100644
--- a/includes/api/ApiDelete.php
+++ b/includes/api/ApiDelete.php
@@ -127,12 +127,12 @@ class ApiDelete extends ApiBase {
 	}
 
 	/**
-	 * @param $page WikiPage|Page object to work on
-	 * @param $user User doing the action
-	 * @param $token
-	 * @param $oldimage
-	 * @param $reason
-	 * @param $suppress bool
+	 * @param Page $page Object to work on
+	 * @param User $user User doing the action
+	 * @param string $token Delete token (same as edit token)
+	 * @param string $oldimage Archive name
+	 * @param string $reason Reason for the deletion. Autogenerated if null.
+	 * @param bool $suppress Whether to mark all deleted versions as restricted
 	 * @return Status|array
 	 */
 	public static function deleteFile( Page $page, User $user, $token, $oldimage, &$reason = null, $suppress = false ) {