Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/382959 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ib86f338eebffc3ee874b97c778f7819fea29bde3
---
M SpecialVipsTest.php
M VipsScaler_body.php
M phpcs.xml
3 files changed, 18 insertions(+), 23 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/VipsScaler
refs/changes/59/382959/1
diff --git a/SpecialVipsTest.php b/SpecialVipsTest.php
index 89bd03b..37ffa2e 100644
--- a/SpecialVipsTest.php
+++ b/SpecialVipsTest.php
@@ -31,7 +31,7 @@
/**
* Entry point
- * @param $par Array TODO describe what is expected there
+ * @param string|null $par TODO describe what is expected there
*/
public function execute( $par ) {
$request = $this->getRequest();
@@ -208,7 +208,7 @@
/**
* @param string $input
- * @param $alldata
+ * @param array $alldata
* @return bool|String
*/
public static function validateFileInput( $input, $alldata ) {
@@ -232,9 +232,9 @@
}
/**
- * @param $input
- * @param $allData
- * @return bool|String
+ * @param int $input
+ * @param array $allData
+ * @return bool|string
*/
public static function validateWidth( $input, $allData ) {
if ( self::validateFileInput( $allData['File'], $allData ) !==
true
@@ -252,8 +252,8 @@
}
/**
- * @param $input
- * @param $allData
+ * @param int $input
+ * @param array $allData
* @return bool|String
*/
public static function validateSharpen( $input, $allData ) {
@@ -265,7 +265,7 @@
/**
* Process data submitted by the form.
- * @param $data array
+ * @param array $data
* @return Status
*/
public static function processForm( array $data ) {
@@ -415,8 +415,8 @@
/**
* Generates a blank page with given HTTP error code
*
- * @param $code Integer HTTP error either 404 or 500
- * @param $error string
+ * @param int $code HTTP error either 404 or 500
+ * @param string $error
*/
protected function streamError( $code, $error = '' ) {
$output = $this->getOutput();
diff --git a/VipsScaler_body.php b/VipsScaler_body.php
index 72043b5..c5d6fd6 100644
--- a/VipsScaler_body.php
+++ b/VipsScaler_body.php
@@ -36,8 +36,8 @@
*
* @param BitmapHandler $handler
* @param File $file
- * @param array $params
- * @param MediaTransformOutput $mto
+ * @param array &$params
+ * @param MediaTransformOutput &$mto
* @return bool
*/
public static function onTransform( $handler, $file, &$params, &$mto ) {
@@ -117,10 +117,10 @@
}
/**
- * @param $handler BitmapHandler
- * @param $file File
- * @param $params array
- * @param $options array
+ * @param BitmapHandler $handler
+ * @param File $file
+ * @param array $params
+ * @param array $options
* @return array
*/
public static function makeCommands( $handler, $file, $params, $options
) {
@@ -508,7 +508,7 @@
* This is a little hacky, but im_shrink and shrink have
* a different format for specifying page number.
*
- * @param $page integer Page number (1-indexed)
+ * @param int $page Page number (1-indexed)
* @return string String to append to filename
*/
public function makePageArgument( $page ) {
diff --git a/phpcs.xml b/phpcs.xml
index 9f262b1..32990b8 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,16 +2,11 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
<exclude
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
</rule>
<file>.</file>
<arg name="extensions" value="php,php5,inc" />
- <arg name="encoding" value="utf8" />
- <exclude-pattern>vendor</exclude-pattern>
- <exclude-pattern>node_modules</exclude-pattern>
+ <arg name="encoding" value="UTF-8" />
</ruleset>
--
To view, visit https://gerrit.wikimedia.org/r/382959
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ib86f338eebffc3ee874b97c778f7819fea29bde3
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/VipsScaler
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
