[MediaWiki-commits] [Gerrit] Minor parameter documentation improvements - change (mediawiki...VipsScaler)

[Reedy (Code Review)]

Reedy has uploaded a new change for review.

  https://gerrit.wikimedia.org/r/76006


Change subject: Minor parameter documentation improvements
......................................................................

Minor parameter documentation improvements

Change-Id: I6ec37093bac0baf5255c027e3fdbd61010bdb527
---
M SpecialVipsTest.php
M VipsScaler_body.php
2 files changed, 18 insertions(+), 9 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/VipsScaler 
refs/changes/06/76006/1

diff --git a/SpecialVipsTest.php b/SpecialVipsTest.php
index eaafdbe..c065f38 100644
--- a/SpecialVipsTest.php
+++ b/SpecialVipsTest.php
@@ -202,7 +202,7 @@
        }
 
        /**
-        * @param $input
+        * @param $input string
         * @param $alldata
         * @return bool|String
         */
@@ -343,6 +343,9 @@
                        }
 
                        # Call the hook
+                       /**
+                        * @var $mto MediaTransformOutput
+                        */
                        $mto = null;
                        VipsScaler::doTransform( $handler, $file, 
$scalerParams, $options, $mto );
                        if ( $mto && !$mto->isError() ) {
diff --git a/VipsScaler_body.php b/VipsScaler_body.php
index b65bd1d..63c204e 100644
--- a/VipsScaler_body.php
+++ b/VipsScaler_body.php
@@ -55,7 +55,7 @@
         *
         * @see VipsScaler::onTransform
         *
-        * @param BitmapHandler $handler
+        * @param BitmapHandler|MediaHandler $handler
         * @param File $file
         * @param array $params
         * @param array $options
@@ -71,6 +71,9 @@
                }
 
                # Execute the commands
+               /**
+                * @var $command VipsCommand
+                */
                foreach ( $vipsCommands as $i => $command ) {
                        # Set input/output files
                        if ( $i == 0 && count( $vipsCommands ) == 1 ) {
@@ -230,14 +233,13 @@
                return $conv;
        }
 
-
        /**
         * Check the file and params against $wgVipsOptions
         *
-        * @param BitmapHandler $handler
+        * @param MediaHandler|BitmapHandler $handler
         * @param File $file
         * @param array $params
-        * @return bool
+        * @return bool|array
         */
        protected static function getHandlerOptions( $handler, $file, $params ) 
{
                global $wgVipsOptions;
@@ -343,6 +345,11 @@
 
        /** Flag to indicate that the output file should be a temporary .v file 
*/
        const TEMP_OUTPUT = true;
+       private $err;
+       private $output;
+       private $input;
+       private $removeInput;
+
        /**
         * Constructor
         *
@@ -432,12 +439,11 @@
         * Generate a random, non-existent temporary file with a specified
         * extension.
         *
-        * @param string $extension Extension
-        * @return string
+        * @param $extension string Extension
+        * @return TempFSFile
         */
        public static function makeTemp( $extension ) {
-               $tmpFile = TempFSFile::factory( 'vips_', $extension );
-               return $tmpFile;
+               return TempFSFile::factory( 'vips_', $extension );
        }
 
 }

-- 
To view, visit https://gerrit.wikimedia.org/r/76006
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I6ec37093bac0baf5255c027e3fdbd61010bdb527
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/VipsScaler
Gerrit-Branch: master
Gerrit-Owner: Reedy <re...@wikimedia.org>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits