Improving comments in File class
authorkaldari <kaldari@gmail.com>
Sun, 7 Jul 2013 20:54:26 +0000 (13:54 -0700)
committerkaldari <kaldari@gmail.com>
Mon, 8 Jul 2013 17:36:10 +0000 (10:36 -0700)
Change-Id: I5d1653f84f7e9324b234c2cc49e7ee5a1d0676ff

includes/filerepo/file/File.php

index 0da4036..9060731 100644 (file)
@@ -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
         */