wikimedia / mediawiki

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" );

includes/media/ExifBitmap.php

Doc Comments +1 added lines, -1 removed lines

@@ -82,7 +82,7 @@
 
 	/**
 	 * @param File $image
-	 * @param array $metadata
+	 * @param boolean $metadata
 	 * @return bool|int
 	 */
 	function isMetadataValid( $image, $metadata ) {

includes/media/FormatMetadata.php

Doc Comments +3 added lines, -3 removed lines

@@ -1230,8 +1230,8 @@ 
 	 * numbers, joins arrays of numbers with commas.
 	 *
 	 * @param mixed $num The value to format
-	 * @param float|int|bool $round Digits to round to or false.
-	 * @return mixed A floating point number or whatever we were fed
+	 * @param integer $round Digits to round to or false.
+	 * @return string|null A floating point number or whatever we were fed
 	 */
 	private function formatNum( $num, $round = false ) {
 		$m = array();
@@ -1396,7 +1396,7 @@ 
 	 *
 	 * @param int $coord Degrees, minutes and seconds
 	 * @param string $type Latitude or longitude (for if its a NWS or E)
-	 * @return mixed A floating point number or whatever we were fed
+	 * @return string A floating point number or whatever we were fed
 	 */
 	private function formatCoords( $coord, $type ) {
 		$ref = '';

includes/media/JpegMetadataExtractor.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
 	 * and those can't extract xmp on files containing both exif and xmp data
 	 *
 	 * @param string $filename Name of jpeg file
-	 * @return array Array of interesting segments.
+	 * @return string Array of interesting segments.
 	 * @throws MWException If given invalid file.
 	 */
 	static function segmentSplitter( $filename ) {

includes/media/MediaHandler.php

Doc Comments +7 added lines, -7 removed lines

@@ -196,7 +196,7 @@ 
 	 *
 	 * @note This method is currently unused.
 	 * @param File $image
-	 * @return string
+	 * @return boolean
 	 */
 	function getMetadataType( $image ) {
 		return false;
@@ -251,7 +251,7 @@ 
 	 * this interface, it should return an empty array, not false.
 	 *
 	 * @param File $file
-	 * @return array|bool False if interface not supported
+	 * @return boolean False if interface not supported
 	 * @since 1.23
 	 */
 	public function getCommonMetaArray( File $file ) {
@@ -268,7 +268,7 @@ 
 	 * @param File $image
 	 * @param string $script
 	 * @param array $params
-	 * @return bool|ThumbnailImage
+	 * @return boolean
 	 */
 	function getScriptedTransform( $image, $script, $params ) {
 		return false;
@@ -308,7 +308,7 @@ 
 	 * @param string $ext Extension of original file
 	 * @param string $mime MIME type of original file
 	 * @param array $params Handler specific rendering parameters
-	 * @return array Thumbnail extension and MIME type
+	 * @return string[] Thumbnail extension and MIME type
 	 */
 	function getThumbType( $ext, $mime, $params = null ) {
 		$magic = MimeMagic::singleton();
@@ -451,7 +451,7 @@ 
 	 * Currently overloaded by PDF and DjVu handlers
 	 * @param File $image
 	 * @param int $page Page number to get information for
-	 * @return bool|string Page text or false when no text found or if
+	 * @return boolean Page text or false when no text found or if
 	 *   unsupported.
 	 */
 	function getPageText( File $image, $page ) {
@@ -508,7 +508,7 @@ 
 	 * indication of grouped and chained streams in ogg container files.
 	 * @param File $image
 	 * @param bool|IContextSource $context Context to use (optional)
-	 * @return array|bool
+	 * @return boolean
 	 */
 	function formatMetadata( $image, $context = false ) {
 		return false;
@@ -648,7 +648,7 @@ 
 	 * @param int $boxWidth Width of the thumbnail box.
 	 * @param int $boxHeight Height of the thumbnail box.
 	 * @param int $maxHeight Maximum height expected for the thumbnail.
-	 * @return int
+	 * @return double
 	 */
 	public static function fitBoxWidth( $boxWidth, $boxHeight, $maxHeight ) {
 		$idealWidth = $boxWidth * $maxHeight / $boxHeight;

includes/media/MediaTransformOutput.php

Doc Comments +6 added lines, -3 removed lines

@@ -80,14 +80,14 @@ 
 	/**
 	 * Get the final extension of the thumbnail.
 	 * Returns false for scripted transformations.
-	 * @return string|bool
+	 * @return string|false
 	 */
 	public function getExtension() {
 		return $this->path ? FileBackend::extensionFromPath( $this->path ) : false;
 	}
 
 	/**
-	 * @return string|bool The thumbnail URL
+	 * @return string The thumbnail URL
 	 */
 	public function getUrl() {
 		return $this->url;
@@ -214,7 +214,7 @@ 
 	 *
 	 * @deprecated since 1.26, use streamFileWithStatus
 	 * @param array $headers Additional HTTP headers to send on success
-	 * @return bool Success
+	 * @return boolean|null Success
 	 */
 	public function streamFile( $headers = array() ) {
 		$this->streamFileWithStatus( $headers )->isOK();
@@ -443,6 +443,9 @@ 
 	/** @var string Plain text formatted version of the error */
 	private $textMsg;
 
+	/**
+	 * @param string $msg
+	 */
 	function __construct( $msg, $width, $height /*, ... */ ) {
 		$args = array_slice( func_get_args(), 3 );
 		$htmlArgs = array_map( 'htmlspecialchars', $args );

includes/media/SVGMetadataExtractor.php

Doc Comments +5 added lines, -1 removed lines

@@ -29,6 +29,10 @@ 
  * @ingroup Media
  */
 class SVGMetadataExtractor {
+
+	/**
+	 * @param string $filename
+	 */
 	static function getMetadata( $filename ) {
 		$svg = new SVGReader( $filename );
 
@@ -372,7 +376,7 @@ 
 	 * http://www.w3.org/TR/SVG11/coords.html#UnitIdentifiers
 	 *
 	 * @param string $length CSS/SVG length.
-	 * @param float|int $viewportSize Optional scale for percentage units...
+	 * @param integer $viewportSize Optional scale for percentage units...
 	 * @return float Length in pixels
 	 */
 	static function scaleSVGUnit( $length, $viewportSize = 512 ) {

includes/media/WebP.php

Doc Comments +4 added lines, -2 removed lines

@@ -43,6 +43,9 @@ 
 	const VP8X_XMP = 4;
 	const VP8X_ANIM = 2;
 
+	/**
+	 * @param string $filename
+	 */
 	public function getMetadata( $image, $filename ) {
 		$parsedWebPData = self::extractMetadata( $filename );
 		if ( !$parsedWebPData ) {
@@ -86,7 +89,6 @@ 
 	/**
 	 * Extracts the image size and WebP type from a file
 	 *
-	 * @param string $chunks Chunks as extracted by RiffExtractor
 	 * @return array|bool Header data array with entries 'compression', 'width' and 'height',
 	 * where 'compression' can be 'lossy', 'lossless', 'animated' or 'unknown'. False if
 	 * file is not a valid WebP file.
@@ -289,7 +291,7 @@ 
 	 * @param $ext
 	 * @param $mime
 	 * @param $params
-	 * @return array
+	 * @return string[]
 	 */
 	public function getThumbType( $ext, $mime, $params = null ) {
 		return array( 'png', 'image/png' );