Add method parameter type documentation

Cleanup returns

Change-Id: Ic559c86883e5ead549fa5827853c7ca7a42b79ca

diff --git a/maintenance/cleanupTable.inc b/maintenance/cleanupTable.inc
index 410a55c..48bb53e 100644 (file)
--- a/maintenance/cleanupTable.inc
+++ b/maintenance/cleanupTable.inc
@@ -41,6 +41,8 @@ class TableCleanup extends Maintenance {
        public $batchSize = 100;
        public $reportInterval = 100;
 
+       protected $processed, $updated, $count, $startTime, $table;
+
        public function __construct() {
                parent::__construct();
                $this->addOption( 'dry-run', 'Perform a dry run' );
@@ -66,6 +68,9 @@ class TableCleanup extends Maintenance {
                $this->table = $table;
        }
 
+       /**
+        * @param int $updated
+        */
        protected function progress( $updated ) {
                $this->updated += $updated;
                $this->processed++;
@@ -96,6 +101,10 @@ class TableCleanup extends Maintenance {
                flush();
        }
 
+       /**
+        * @param array $params
+        * @throws MWException
+        */
        public function runTable( $params ) {
                $dbr = wfGetDB( DB_SLAVE );
 
@@ -156,6 +165,10 @@ class TableCleanup extends Maintenance {
                $this->output( "Finished $table... $this->updated of $this->processed rows updated\n" );
        }
 
+       /**
+        * @param array $matches
+        * @return string
+        */
        protected function hexChar( $matches ) {
                return sprintf( "\\x%02x", ord( $matches[1] ) );
        }

diff --git a/maintenance/cleanupTitles.php b/maintenance/cleanupTitles.php
index 895254f..ae256ab 100644 (file)
--- a/maintenance/cleanupTitles.php
+++ b/maintenance/cleanupTitles.php
@@ -42,6 +42,9 @@ class TitleCleanup extends TableCleanup {
                $this->mDescription = "Script to clean up broken, unparseable titles";
        }
 
+       /**
+        * @param object $row
+        */
        protected function processRow( $row ) {
                global $wgContLang;
                $display = Title::makeName( $row->page_namespace, $row->page_title );
@@ -53,23 +56,28 @@ class TitleCleanup extends TableCleanup {
                        && $title->getNamespace() == $row->page_namespace
                        && $title->getDBkey() === $row->page_title )
                {
-                       return $this->progress( 0 );  // all is fine
+                       $this->progress( 0 );  // all is fine
+                       return;
                }
 
                if ( $row->page_namespace == NS_FILE && $this->fileExists( $row->page_title ) ) {
                        $this->output( "file $row->page_title needs cleanup, please run cleanupImages.php.\n" );
-                       return $this->progress( 0 );
+                       $this->progress( 0 );
                } elseif ( is_null( $title ) ) {
                        $this->output( "page $row->page_id ($display) is illegal.\n" );
                        $this->moveIllegalPage( $row );
-                       return $this->progress( 1 );
+                       $this->progress( 1 );
                } else {
                        $this->output( "page $row->page_id ($display) doesn't match self.\n" );
                        $this->moveInconsistentPage( $row, $title );
-                       return $this->progress( 1 );
+                       $this->progress( 1 );
                }
        }
 
+       /**
+        * @param string $name
+        * @return bool
+        */
        protected function fileExists( $name ) {
                // XXX: Doesn't actually check for file existence, just presence of image record.
                // This is reasonable, since cleanupImages.php only iterates over the image table.
@@ -78,6 +86,9 @@ class TitleCleanup extends TableCleanup {
                return $row !== false;
        }
 
+       /**
+        * @param object $row
+        */
        protected function moveIllegalPage( $row ) {
                $legal = 'A-Za-z0-9_/\\\\-';
                $legalized = preg_replace_callback( "!([^$legal])!",
@@ -115,6 +126,10 @@ class TitleCleanup extends TableCleanup {
                }
        }
 
+       /**
+        * @param object $row
+        * @param Title $title
+        */
        protected function moveInconsistentPage( $row, $title ) {
                if ( $title->exists() || $title->getInterwiki() || !$title->canExist() ) {
                        if ( $title->getInterwiki() || !$title->canExist() ) {