wikimedia / mediawiki

includes/MediaWikiServices.php

Doc Comments +1 added lines, -1 removed lines

@@ -183,7 +183,7 @@
 	 * given $bootstrapConfig. In particular, all wiring files defined in the
 	 * ServiceWiringFiles setting are loaded, and the MediaWikiServices hook is called.
 	 *
-	 * @param Config|null $bootstrapConfig The Config object to be registered as the
+	 * @param Config $bootstrapConfig The Config object to be registered as the
 	 *        'BootstrapConfig' service. This has to contain at least the information
 	 *        needed to set up the 'ConfigFactory' service. If not provided, any call
 	 *        to getBootstrapConfig(), getConfigFactory, or getMainConfig will fail.

includes/media/Bitmap.php

Doc Comments +2 added lines, -2 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;
@@ -108,7 +108,7 @@ 
 	 * Get ImageMagick subsampling factors for the target JPEG pixel format.
 	 *
 	 * @param string $pixelFormat one of 'yuv444', 'yuv422', 'yuv420'
-	 * @return array of string keys
+	 * @return string[] of string keys
 	 */
 	protected function imageMagickSubsampling( $pixelFormat ) {
 		switch ( $pixelFormat ) {

includes/media/TransformationalImageHandler.php

Doc Comments +1 added lines, -1 removed lines

@@ -563,7 +563,7 @@
 	 * @param array $params Rotate parameters.
 	 *   'rotation' clockwise rotation in degrees, allowed are multiples of 90
 	 * @since 1.24 Is non-static. From 1.21 it was static
-	 * @return bool
+	 * @return MediaTransformError
 	 */
 	public function rotate( $file, $params ) {
 		return new MediaTransformError( 'thumbnail_error', 0, 0,

includes/parser/BlockLevelPass.php

Doc Comments +2 added lines

@@ -53,6 +53,8 @@
 
 	/**
 	 * Private constructor
+	 * @param string $text
+	 * @param boolean $lineStart
 	 */
 	private function __construct( $text, $lineStart ) {
 		$this->text = $text;

includes/Message.php

Doc Comments +1 added lines, -20 removed lines

@@ -371,8 +371,7 @@ 
 	 *
 	 * @since 1.17
 	 *
-	 * @param string|string[]|MessageSpecifier $key
-	 * @param mixed $param,... Parameters as strings.
+	 * @param string $key
 	 *
 	 * @return Message
 	 */
@@ -415,8 +414,6 @@ 
 	 *
 	 * @since 1.18
 	 *
-	 * @param string|string[] $keys,... Message keys, or first argument as an array of all the
-	 * message keys.
 	 *
 	 * @return Message
 	 */
@@ -487,8 +484,6 @@ 
 	 *
 	 * @since 1.17
 	 *
-	 * @param mixed $params,... Raw parameters as strings, or a single argument that is
-	 * an array of raw parameters.
 	 *
 	 * @return Message $this
 	 */
@@ -509,8 +504,6 @@ 
 	 *
 	 * @since 1.18
 	 *
-	 * @param mixed $param,... Numeric parameters, or a single argument that is
-	 * an array of numeric parameters.
 	 *
 	 * @return Message $this
 	 */
@@ -531,8 +524,6 @@ 
 	 *
 	 * @since 1.22
 	 *
-	 * @param int|int[] $param,... Duration parameters, or a single argument that is
-	 * an array of duration parameters.
 	 *
 	 * @return Message $this
 	 */
@@ -553,8 +544,6 @@ 
 	 *
 	 * @since 1.22
 	 *
-	 * @param string|string[] $param,... Expiry parameters, or a single argument that is
-	 * an array of expiry parameters.
 	 *
 	 * @return Message $this
 	 */
@@ -575,8 +564,6 @@ 
 	 *
 	 * @since 1.22
 	 *
-	 * @param int|int[] $param,... Time period parameters, or a single argument that is
-	 * an array of time period parameters.
 	 *
 	 * @return Message $this
 	 */
@@ -597,8 +584,6 @@ 
 	 *
 	 * @since 1.22
 	 *
-	 * @param int|int[] $param,... Size parameters, or a single argument that is
-	 * an array of size parameters.
 	 *
 	 * @return Message $this
 	 */
@@ -619,8 +604,6 @@ 
 	 *
 	 * @since 1.22
 	 *
-	 * @param int|int[] $param,... Bit rate parameters, or a single argument that is
-	 * an array of bit rate parameters.
 	 *
 	 * @return Message $this
 	 */
@@ -643,8 +626,6 @@ 
 	 *
 	 * @since 1.25
 	 *
-	 * @param string|string[] $param,... plaintext parameters, or a single argument that is
-	 * an array of plaintext parameters.
 	 *
 	 * @return Message $this
 	 */

includes/resourceloader/ResourceLoaderFileModule.php

Doc Comments +3 added lines, -2 removed lines

@@ -381,7 +381,7 @@ 
 	 * Get all styles for a given context.
 	 *
 	 * @param ResourceLoaderContext $context
-	 * @return array CSS code for $context as an associative array mapping media type to CSS text.
+	 * @return string CSS code for $context as an associative array mapping media type to CSS text.
 	 */
 	public function getStyles( ResourceLoaderContext $context ) {
 		$styles = $this->readStyleFiles(
@@ -631,7 +631,7 @@ 
 	 * @param array $list List of file paths in any combination of index/path
 	 *     or path/options pairs
 	 * @param string $option Option name
-	 * @param mixed $default Default value if the option isn't set
+	 * @param string $default Default value if the option isn't set
 	 * @return array List of file paths, collated by $option
 	 */
 	protected static function collateFilePathListByOption( array $list, $option, $default ) {
@@ -1007,6 +1007,7 @@ 
 	 * the BOM character is not valid in the middle of a string.
 	 * We already assume UTF-8 everywhere, so this should be safe.
 	 *
+	 * @param string $input
 	 * @return string input minus the intial BOM char
 	 */
 	protected function stripBom( $input ) {

includes/media/DjVu.php

Doc Comments +3 added lines

@@ -371,6 +371,9 @@
 		return 'djvuxml';
 	}
 
+	/**
+	 * @param File $image
+	 */
 	function isMetadataValid( $image, $metadata ) {
 		return !empty( $metadata ) && $metadata != serialize( [] );
 	}

includes/media/MediaHandler.php

Doc Comments +3 added lines, -3 removed lines

@@ -196,7 +196,7 @@ 
 	 *
 	 * @note This method is currently unused.
 	 * @param File $image
-	 * @return string
+	 * @return boolean
 	 */
 	function getMetadataType( $image ) {
 		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();
@@ -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 +5 added lines, -2 removed lines

@@ -80,7 +80,7 @@ 
 	/**
 	 * 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;
@@ -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 = [] ) {
 		$this->streamFileWithStatus( $headers )->isOK();
@@ -445,6 +445,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 );