Convert many comments to phpdoc style, and document some more functions

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

diff --git a/includes/DifferenceEngine.php b/includes/DifferenceEngine.php
index eee7c61..52bf654 100644 (file)
--- a/includes/DifferenceEngine.php
+++ b/includes/DifferenceEngine.php
@@ -1,6 +1,13 @@
 <?php
-# See diff.doc
+/**
+ * See diff.doc
+ * @package MediaWiki 
+ */
 
+/**
+ * @todo document
+ * @package MediaWiki
+ */
 class DifferenceEngine {
        /* private */ var $mOldid, $mNewid;
        /* private */ var $mOldtitle, $mNewtitle, $mPagetitle;
@@ -257,6 +264,7 @@ class DifferenceEngine {
                        $s = $dbr->getArray( 'cur', array( 'cur_text', 'cur_user_text', 'cur_comment' ),
                                array( 'cur_id' => $id ), $fname );
                        if ( $s === false ) {
+                               wfDebug( "Unable to load cur_id $id\n" );
                                return false;
                        }
 
@@ -269,6 +277,7 @@ class DifferenceEngine {
                                'old_flags','old_user_text','old_comment' ), array( 'old_id' => $this->mNewid ), $fname );
 
                        if ( $s === false ) {
+                               wfDebug( "Unable to load old_id {$this->mNewid}\n" );
                                return false;
                        }
 
@@ -290,15 +299,20 @@ class DifferenceEngine {
                                        'old_title' => $this->mNewPage->getDBkey()
                                ), $fname, array( 'ORDER BY' => 'inverse_timestamp', 'USE INDEX' => 'name_title_timestamp' )
                        );
+                       if ( $s === false ) {
+                               wfDebug( 'Unable to load ' . $this->mNewPage->getPrefixedDBkey . " from old\n" );
+                               return false;
+                       }
                } else {
                        $s = $dbr->getArray( 'old',
                                array( 'old_namespace','old_title','old_timestamp','old_text','old_flags','old_user_text','old_comment'),
                                array( 'old_id' => $this->mOldid ),
                                $fname
                        );
-               }
-               if ( $s === false ) {
-                       return false;
+                       if ( $s === false ) {
+                               wfDebug( "Unable to load old_id {$this->mOldid}\n" );
+                               return false;
+                       }
                }
                $this->mOldPage = Title::MakeTitle( $s->old_namespace, $s->old_title );
                $this->mOldtext = Article::getRevisionText( $s );
@@ -321,6 +335,10 @@ class DifferenceEngine {
 
 define('USE_ASSERTS', function_exists('assert'));
 
+/**
+ * @todo document
+ * @package MediaWiki
+ */
 class _DiffOp {
        var $type;
        var $orig;
@@ -339,6 +357,10 @@ class _DiffOp {
        }
 }
 
+/**
+ * @todo document
+ * @package MediaWiki
+ */
 class _DiffOp_Copy extends _DiffOp {
        var $type = 'copy';
 
@@ -354,6 +376,10 @@ class _DiffOp_Copy extends _DiffOp {
        }
 }
 
+/**
+ * @todo document
+ * @package MediaWiki
+ */
 class _DiffOp_Delete extends _DiffOp {
        var $type = 'delete';
 
@@ -367,6 +393,10 @@ class _DiffOp_Delete extends _DiffOp {
        }
 }
 
+/**
+ * @todo document
+ * @package MediaWiki
+ */
 class _DiffOp_Add extends _DiffOp {
        var $type = 'add';
 
@@ -380,6 +410,10 @@ class _DiffOp_Add extends _DiffOp {
        }
 }
 
+/**
+ * @todo document
+ * @package MediaWiki
+ */
 class _DiffOp_Change extends _DiffOp {
        var $type = 'change';
 
@@ -412,6 +446,7 @@ class _DiffOp_Change extends _DiffOp {
  * are my own.
  *
  * @author Geoffrey T. Dairiki
+ * @package MediaWiki
  * @access private
  */
 class _DiffEngine
@@ -797,6 +832,8 @@ class _DiffEngine
 
 /**
  * Class representing a 'diff' between two sequences of strings.
+ * @todo document
+ * @package MediaWiki
  */
 class Diff
 {
@@ -932,9 +969,10 @@ class Diff
 
 /**
  * FIXME: bad name.
+ * @todo document
+ * @package MediaWiki
  */
-class MappedDiff
-extends Diff
+class MappedDiff extends Diff
 {
        /**
         * Constructor.
@@ -990,6 +1028,8 @@ extends Diff
  * This class formats the diff in classic diff format.
  * It is intended that this class be customized via inheritance,
  * to obtain fancier outputs.
+ * @todo document
+ * @package MediaWiki
  */
 class DiffFormatter
 {
@@ -1145,6 +1185,10 @@ class DiffFormatter
 
 define('NBSP', '&#160;');                      // iso-8859-x non-breaking space.
 
+/**
+ * @todo document
+ * @package MediaWiki
+ */
 class _HWLDF_WordAccumulator {
        function _HWLDF_WordAccumulator () {
                $this->_lines = array();
@@ -1198,6 +1242,10 @@ class _HWLDF_WordAccumulator {
        }
 }
 
+/**
+ * @todo document
+ * @package MediaWiki
+ */
 class WordLevelDiff extends MappedDiff
 {
        function WordLevelDiff ($orig_lines, $closing_lines) {
@@ -1245,7 +1293,8 @@ class WordLevelDiff extends MappedDiff
 
 /**
  *     Wikipedia Table style diff formatter.
- *
+ * @todo document
+ * @package MediaWiki
  */
 class TableDiffFormatter extends DiffFormatter
 {