wikimedia / mediawiki

maintenance/checkSyntax.php

Doc Comments +11 added lines

@@ -363,6 +363,12 @@ 
 		$this->checkRegex( $file, $text, '/^[\xFF\xFE\xEF]/', 'byte-order mark' );
 	}
 
+	/**
+	 * @param string $file
+	 * @param string $text
+	 * @param string $regex
+	 * @param string $desc
+	 */
 	private function checkRegex( $file, $text, $regex, $desc ) {
 		if ( !preg_match( $regex, $text ) ) {
 			return;
@@ -375,6 +381,11 @@ 
 		$this->output( "Warning in file $file: $desc found.\n" );
 	}
 
+	/**
+	 * @param string $file
+	 * @param string $evilToken
+	 * @param string $desc
+	 */
 	private function checkEvilToken( $file, $tokens, $evilToken, $desc ) {
 		if ( !in_array( $evilToken, $tokens ) ) {
 			return;

maintenance/compareParsers.php

Doc Comments +3 added lines

@@ -112,6 +112,9 @@
 		}
 	}
 
+	/**
+	 * @return string
+	 */
 	function stripParameters( $text ) {
 		if ( !$this->stripParametersEnabled ) {
 			return $text;

maintenance/convertExtensionToRegistration.php

Doc Comments +6 added lines

@@ -185,6 +185,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $dir
+	 */
 	private function stripPath( $val, $dir ) {
 		if ( $val === $dir ) {
 			$val = '';
@@ -266,6 +269,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $path
+	 */
 	protected function needsComposerAutoloader( $path ) {
 		$path .= '/composer.json';
 		if ( file_exists( $path ) ) {

maintenance/copyJobQueue.php

Doc Comments +3 added lines

@@ -70,6 +70,9 @@
 		}
 	}
 
+	/**
+	 * @param Iterator $jobs
+	 */
 	protected function copyJobs( JobQueue $src, JobQueue $dst, $jobs ) {
 		$total = 0;
 		$totalOK = 0;

maintenance/dumpTextPass.php

Doc Comments +15 added lines, -1 removed lines

@@ -230,6 +230,9 @@ 
 		$this->timeOfCheckpoint = $this->startTime;
 	}
 
+	/**
+	 * @param boolean $history
+	 */
 	function dump( $history, $text = WikiExporter::TEXT ) {
 		// Notice messages will foul up your XML output even if they're
 		// relatively harmless.
@@ -521,7 +524,7 @@ 
 	 * is thrown.
 	 *
 	 * @param string $id The revision id to get the text for
-	 * @param string|bool|null $model The content model used to determine
+	 * @param string $model The content model used to determine
 	 *  applicable export transformations.
 	 *  If $model is null, it will be determined from the database.
 	 * @param string|null $format The content format used when applying export transformations.
@@ -716,6 +719,11 @@ 
 		return $normalized;
 	}
 
+	/**
+	 * @param string $id
+	 *
+	 * @return string|null
+	 */
 	private function getTextSpawned( $id ) {
 		MediaWiki\suppressWarnings();
 		if ( !$this->spawnProc ) {
@@ -948,6 +956,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $data
+	 */
 	function characterData( $parser, $data ) {
 		$this->clearOpenElement( null );
 		if ( $this->lastName == "id" ) {
@@ -973,6 +984,9 @@ 
 		$this->buffer .= htmlspecialchars( $data );
 	}
 
+	/**
+	 * @param null|string $style
+	 */
 	function clearOpenElement( $style ) {
 		if ( $this->openElement ) {
 			$this->buffer .= Xml::element( $this->openElement[0], $this->openElement[1], $style );

maintenance/dumpUploads.php

Doc Comments +3 added lines

@@ -108,6 +108,9 @@
 		}
 	}
 
+	/**
+	 * @param boolean $shared
+	 */
 	function outputItem( $name, $shared ) {
 		$file = wfFindFile( $name );
 		if ( $file && $this->filterItem( $file, $shared ) ) {

maintenance/findDeprecated.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
 		return $retVal;
 	}
 
+	/**
+	 * @param string $filename
+	 */
 	public function setCurrentFile( $filename ) {
 		$this->currentFile = $filename;
 	}

maintenance/findOrphanedFiles.php

Doc Comments +3 added lines

@@ -70,6 +70,9 @@
 		$this->checkFiles( $repo, $pathBatch, $verbose );
 	}
 
+	/**
+	 * @param boolean $verbose
+	 */
 	protected function checkFiles( LocalRepo $repo, array $paths, $verbose ) {
 		if ( !count( $paths ) ) {
 			return;

maintenance/importDump.php

Doc Comments +3 added lines

@@ -275,6 +275,9 @@
 		return $this->importFromHandle( $file );
 	}
 
+	/**
+	 * @param resource $handle
+	 */
 	function importFromHandle( $handle ) {
 		$this->startTime = microtime( true );