From 1d0d879be013f8cc8bfd993608b1e740deef56b1 Mon Sep 17 00:00:00 2001 From: Alexandre Emsenhuber Date: Wed, 13 Jan 2010 21:25:03 +0000 Subject: [PATCH] * Document a bit * Fix some doxygen warnings --- includes/FileDeleteForm.php | 15 ++++++++++++--- includes/FileRevertForm.php | 2 +- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/includes/FileDeleteForm.php b/includes/FileDeleteForm.php index 1937cedc5c..dad19524c3 100644 --- a/includes/FileDeleteForm.php +++ b/includes/FileDeleteForm.php @@ -17,7 +17,7 @@ class FileDeleteForm { /** * Constructor * - * @param File $file File we're deleting + * @param $file File object we're deleting */ public function __construct( $file ) { $this->title = $file->getTitle(); @@ -90,6 +90,15 @@ class FileDeleteForm { $this->showLogEntries(); } + /** + * Really delete the file + * + * @param $title Title object + * @param $file File object + * @param $oldimage String: archive name + * @param $reason String: reason of the deletion + * @param $suppress Boolean: whether to mark all deleted versions as restricted + */ public static function doDelete( &$title, &$file, &$oldimage, $reason, $suppress ) { global $wgUser; $article = null; @@ -226,8 +235,8 @@ class FileDeleteForm { * showing an appropriate message depending upon whether * it's a current file or an old version * - * @param string $message Message base - * @return string + * @param $message String: message base + * @return String */ private function prepareMessage( $message ) { global $wgLang; diff --git a/includes/FileRevertForm.php b/includes/FileRevertForm.php index a058d061f2..eb16693a02 100644 --- a/includes/FileRevertForm.php +++ b/includes/FileRevertForm.php @@ -17,7 +17,7 @@ class FileRevertForm { /** * Constructor * - * @param File $file File we're reverting + * @param $file File we're reverting */ public function __construct( $file ) { $this->title = $file->getTitle(); -- 2.20.1