From: kaldari <kaldari@gmail.com>
Date: Sun, 7 Jul 2013 20:54:26 +0000 (-0700)
Subject: Improving comments in File class
X-Git-Tag: 1.31.0-rc.0~19240^2
X-Git-Url: https://git.cyclocoop.org/%7B%24www_url%7Dadmin/compta/banques/%7B%7B%20url_for%28%27admin_users%27%29%20%7D%7D?a=commitdiff_plain;h=26b6aee38c79b32b426e5e68bbe060a214676867;p=lhc%2Fweb%2Fwiklou.git

Improving comments in File class

Change-Id: I5d1653f84f7e9324b234c2cc49e7ee5a1d0676ff
---

diff --git a/includes/filerepo/file/File.php b/includes/filerepo/file/File.php
index 0da4036ac1..9060731724 100644
--- a/includes/filerepo/file/File.php
+++ b/includes/filerepo/file/File.php
@@ -48,6 +48,7 @@
  * @ingroup FileAbstraction
  */
 abstract class File {
+	// Bitfield values akin to the Revision deletion constants
 	const DELETED_FILE = 1;
 	const DELETED_COMMENT = 2;
 	const DELETED_USER = 4;
@@ -1499,7 +1500,7 @@ abstract class File {
 	 * Is this file a "deleted" file in a private archive?
 	 * STUB
 	 *
-	 * @param $field
+	 * @param integer $field one of DELETED_* bitfield constants
 	 *
 	 * @return bool
 	 */