Merge "(bug 38556) Add header and footer messages to MediaWiki's info action"

[lhc/web/wiklou.git] / includes / DataUpdate.php

diff --git a/includes/DataUpdate.php b/includes/DataUpdate.php
index 07e8223..377b64c 100644 (file)
--- a/includes/DataUpdate.php
+++ b/includes/DataUpdate.php
@@ -1,6 +1,7 @@
 <?php
 /**
- * See docs/deferred.txt
+ * Base code for update jobs that do something with some secondary
+ * data extracted from article.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,8 +18,16 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
+ */
+
+/**
  * Abstract base class for update jobs that do something with some secondary
  * data extracted from article.
+ *
+ * @note: subclasses should NOT start or commit transactions in their doUpdate() method,
+ *        a transaction will automatically be wrapped around the update. If need be,
+ *        subclasses can override the beginTransaction() and commitTransaction() methods.
  */
 abstract class DataUpdate implements DeferrableUpdate {
 
@@ -75,8 +84,8 @@ abstract class DataUpdate implements DeferrableUpdate {
                $exception = null;
 
                /**
-                * @var $update StorageUpdate
-                * @var $trans StorageUpdate
+                * @var $update DataUpdate
+                * @var $trans DataUpdate
                 */
 
                try {