RevisionDeleter::getChanges() documentation cleanup
authorAaron Schulz <aaron@users.mediawiki.org>
Thu, 15 Sep 2011 21:22:11 +0000 (21:22 +0000)
committerAaron Schulz <aaron@users.mediawiki.org>
Thu, 15 Sep 2011 21:22:11 +0000 (21:22 +0000)
includes/revisiondelete/RevisionDeleter.php

index 0d67774..b6d3cb6 100644 (file)
@@ -28,12 +28,14 @@ class RevisionDeleter {
        }
 
        /**
-        * Gets an array of message keys describing the changes made to the visibility
-        * of the revision. If the resulting array is $arr, then $arr[0] will contain an
-        * array of strings describing the items that were hidden, $arr[1] will contain
-        * an array of strings describing the items that were unhidden, and $arr[2] will
-        * contain an array with a single string, which can be one of "applied
-        * restrictions to sysops", "removed restrictions from sysops", or null.
+        * Gets an array of message keys describing the changes made to the
+     * visibility of the revision.
+     *
+     * If the resulting array is $arr, then $arr[0] will contain an array of
+     * message keys describing the items that were hidden, $arr[1] will contain
+        * an array of message keys describing the items that were unhidden, and $arr[2]
+     * will contain an array with a single message key, which can be one of
+     * "revdelete-restricted", "revdelete-unrestricted", or null, indicating (un)suppression.
         *
         * @param $n Integer: the new bitfield.
         * @param $o Integer: the old bitfield.