Update documentation for ApiDelete::deleteFile()
authorSiebrand Mazeland <s.mazeland@xs4all.nl>
Sun, 17 Nov 2013 19:04:13 +0000 (20:04 +0100)
committerIAlex <codereview@emsenhuber.ch>
Sun, 17 Nov 2013 19:46:01 +0000 (19:46 +0000)
WikiPage was no longer valid given the current type hint. Added
types and documentation where missing.

Change-Id: Ie0a3a8fff3ad496b723958133867df48a695d3b7

includes/api/ApiDelete.php

index 21264bc..fe5a196 100644 (file)
@@ -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 ) {