Fix documentation of WikiPage::doDeleteArticle(Real)?()
authorAlexandre Emsenhuber <ialex.wiki@gmail.com>
Mon, 13 Aug 2012 14:09:25 +0000 (16:09 +0200)
committerAlexandre Emsenhuber <ialex.wiki@gmail.com>
Mon, 13 Aug 2012 14:09:25 +0000 (16:09 +0200)
- The $suppress parameter is a boolean indicating whether
  revision will be suppressed
- Added @since to WikiPage::doDeleteArticleReal()

Change-Id: I3af14f8cc7bf771f4d07215ca1dba2d6b6f05553

includes/WikiPage.php

index 9dc9c2c..f4ed70d 100644 (file)
@@ -2078,11 +2078,8 @@ class WikiPage extends Page implements IDBAccessObject {
         * Deletes the article with database consistency, writes logs, purges caches
         *
         * @param $reason string delete reason for deletion log
-        * @param $suppress int bitfield
-        *      Revision::DELETED_TEXT
-        *      Revision::DELETED_COMMENT
-        *      Revision::DELETED_USER
-        *      Revision::DELETED_RESTRICTED
+        * @param $suppress boolean suppress all revisions and log the deletion in
+        *        the suppression log instead of the deletion log
         * @param $id int article ID
         * @param $commit boolean defaults to true, triggers transaction end
         * @param &$error Array of errors to append to
@@ -2100,13 +2097,11 @@ class WikiPage extends Page implements IDBAccessObject {
         * Back-end article deletion
         * Deletes the article with database consistency, writes logs, purges caches
         *
+        * @since 1.19
+        *
         * @param $reason string delete reason for deletion log
-        * @param $suppress int bitfield
-        *      Revision::DELETED_TEXT
-        *      Revision::DELETED_COMMENT
-        *      Revision::DELETED_USER
-        *      Revision::DELETED_RESTRICTED
-        * @param $id int article ID
+        * @param $suppress boolean suppress all revisions and log the deletion in
+        *        the suppression log instead of the deletion log
         * @param $commit boolean defaults to true, triggers transaction end
         * @param &$error Array of errors to append to
         * @param $user User The deleting user