wikimedia / mediawiki

includes/libs/XmlTypeCheck.php

Doc Comments +6 added lines, -2 removed lines

@@ -134,7 +134,8 @@ 
 
 
 	/**
-	 * @param string $fname the filename
+	 * @param string $xml
+	 * @param boolean $isFile
 	 */
 	private function validateFromInput( $xml, $isFile ) {
 		$reader = new XMLReader();
@@ -175,6 +176,9 @@ 
 		$this->wellFormed = false;
 	}
 
+	/**
+	 * @param XMLReader $reader
+	 */
 	private function validate( $reader ) {
 
 		// First, move through anything that isn't an element, and
@@ -286,7 +290,7 @@ 
 	}
 
 	/**
-	 * @param $name
+	 * @param string $name
 	 * @param $attribs
 	 */
 	private function elementOpen( $name, $attribs ) {

includes/Licenses.php

Doc Comments +1 added lines, -1 removed lines

@@ -94,7 +94,7 @@
 	/**
 	 * @param array $list
 	 * @param array $path
-	 * @param mixed $item
+	 * @param License $item
 	 */
 	protected function stackItem( &$list, $path, $item ) {
 		$position =& $list;

includes/Linker.php

Doc Comments +7 added lines, -7 removed lines

@@ -706,7 +706,7 @@ 
 	/**
 	 * Make HTML for a thumbnail including image, border and caption
 	 * @param Title $title
-	 * @param File|bool $file File object or false if it doesn't exist
+	 * @param File $file File object or false if it doesn't exist
 	 * @param string $label
 	 * @param string $alt
 	 * @param string $align
@@ -1268,7 +1268,7 @@ 
 	 * @param string|null $wikiId Id (as used by WikiMap) of the wiki to generate links to.
 	 *  For use with external changes.
 	 *
-	 * @return mixed|string
+	 * @return string
 	 */
 	public static function formatComment(
 		$comment, $title = null, $local = false, $wikiId = null
@@ -1494,7 +1494,7 @@ 
 	 * @param string $text
 	 * @param string|null $wikiId Id of the wiki to link to (if not the local wiki),
 	 *  as used by WikiMap.
-	 * @param string|string[] $options See the $options parameter in Linker::link.
+	 * @param string $options See the $options parameter in Linker::link.
 	 *
 	 * @return string HTML link
 	 */
@@ -1736,7 +1736,7 @@ 
 	 * Generate a table of contents from a section tree.
 	 *
 	 * @param array $tree Return value of ParserOutput::getSections()
-	 * @param string|Language|bool $lang Language for the toc title, defaults to user language
+	 * @param Language $lang Language for the toc title, defaults to user language
 	 * @return string HTML fragment
 	 */
 	public static function generateTOC( $tree, $lang = false ) {
@@ -1793,7 +1793,7 @@ 
 	 * Split a link trail, return the "inside" portion and the remainder of the trail
 	 * as a two-element array
 	 * @param string $trail
-	 * @return array
+	 * @return string[]
 	 */
 	static function splitTrail( $trail ) {
 		global $wgContLang;
@@ -1831,7 +1831,7 @@ 
 	 *
 	 * @param Revision $rev
 	 * @param IContextSource $context Context to use or null for the main context.
-	 * @param array $options
+	 * @param string[] $options
 	 * @return string
 	 */
 	public static function generateRollback( $rev, IContextSource $context = null,
@@ -2013,7 +2013,7 @@ 
 	 * @param array $templates Array of templates from Article::getUsedTemplate or similar
 	 * @param bool $preview Whether this is for a preview
 	 * @param bool $section Whether this is for a section edit
-	 * @param Title|Message|string|null $more An escaped link for "More..." of the templates
+	 * @param string|null $more An escaped link for "More..." of the templates
 	 * @return string HTML output
 	 */
 	public static function formatTemplates( $templates, $preview = false,

includes/logging/LogEventsList.php

Doc Comments +3 added lines, -3 removed lines

@@ -413,8 +413,8 @@ 
 
 	/**
 	 * @param stdClass $row Row
-	 * @param string|array $type
-	 * @param string|array $action
+	 * @param string[] $type
+	 * @param string $action
 	 * @param string $right
 	 * @return bool
 	 */
@@ -649,7 +649,7 @@ 
 	 * @param IDatabase $db
 	 * @param string $audience Public/user
 	 * @param User $user User to check, or null to use $wgUser
-	 * @return string|bool String on success, false on failure.
+	 * @return string|false String on success, false on failure.
 	 */
 	public static function getExcludeClause( $db, $audience = 'public', User $user = null ) {
 		global $wgLogRestrictions;

includes/logging/LogFormatter.php

Doc Comments +1 added lines, -1 removed lines

@@ -423,7 +423,7 @@
 	 * Returns a sentence describing the log action. Usually
 	 * a Message object is returned, but old style log types
 	 * and entries might return pre-escaped HTML string.
-	 * @return Message|string Pre-escaped HTML
+	 * @return Message Pre-escaped HTML
 	 */
 	protected function getActionMessage() {
 		$message = $this->msg( $this->getMessageKey() );

includes/mail/EmailNotification.php

Doc Comments +1 added lines, -1 removed lines

@@ -474,7 +474,7 @@
 	 *
 	 * @param User $watchingUser
 	 * @param string $source
-	 * @return bool
+	 * @return Status
 	 * @private
 	 */
 	function sendPersonalised( $watchingUser, $source ) {

includes/media/Bitmap.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
 	 *
 	 * @param string $dstPath
 	 * @param bool $checkDstPath
-	 * @return string|Callable One of client, im, custom, gd, imext or an array( object, method )
+	 * @return string One of client, im, custom, gd, imext or an array( object, method )
 	 */
 	protected function getScalerType( $dstPath, $checkDstPath = true ) {
 		global $wgUseImageResize, $wgUseImageMagick, $wgCustomConvertCommand;

includes/media/DjVu.php

Doc Comments +5 added lines, -1 removed lines

@@ -255,7 +255,7 @@ 
 	 * Get metadata, unserializing it if neccessary.
 	 *
 	 * @param File $file The DjVu file in question
-	 * @return string XML metadata as a string.
+	 * @return boolean XML metadata as a string.
 	 * @throws MWException
 	 */
 	private function getUnserializedMetadata( File $file ) {
@@ -371,6 +371,10 @@ 
 		return 'djvuxml';
 	}
 
+	/**
+	 * @param File $image
+	 * @param boolean $metadata
+	 */
 	function isMetadataValid( $image, $metadata ) {
 		return !empty( $metadata ) && $metadata != serialize( array() );
 	}

includes/media/DjVuImage.php

Doc Comments +12 added lines

@@ -94,6 +94,11 @@ 
 		fclose( $file );
 	}
 
+	/**
+	 * @param resource $file
+	 * @param string $length
+	 * @param integer $indent
+	 */
 	private function dumpForm( $file, $length, $indent ) {
 		$start = ftell( $file );
 		$secondary = fread( $file, 4 );
@@ -187,6 +192,10 @@ 
 		}
 	}
 
+	/**
+	 * @param resource $file
+	 * @param string $formLength
+	 */
 	private function getMultiPageInfo( $file, $formLength ) {
 		// For now, we'll just look for the first page in the file
 		// and report its information, hoping others are the same size.
@@ -390,6 +399,9 @@ 
 		return $xml;
 	}
 
+	/**
+	 * @param string $line
+	 */
 	function parseFormDjvu( $line, &$xml ) {
 		$parentLevel = strspn( $line, ' ' );
 		$line = strtok( "\n" );