From: Alexandre Emsenhuber <ialex@users.mediawiki.org>
Date: Wed, 13 Jan 2010 21:25:03 +0000 (+0000)
Subject: * Document a bit
X-Git-Tag: 1.31.0-rc.0~38282
X-Git-Url: http://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/exercices/?a=commitdiff_plain;h=1d0d879be013f8cc8bfd993608b1e740deef56b1;p=lhc%2Fweb%2Fwiklou.git

* Document a bit
* Fix some doxygen warnings
---

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();