jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/403723 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ieb0b5e4f58fccbf8e8376e56023488b3d2b87ee6
---
M .phpcs.xml
M MolHandler.mime.php
M MolHandlerHooks.php
3 files changed, 7 insertions(+), 13 deletions(-)
Approvals:
jenkins-bot: Verified
Rillke: Looks good to me, approved
diff --git a/.phpcs.xml b/.phpcs.xml
index 1447505..6f3c89d 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -1,10 +1,7 @@
<?xml version="1.0"?>
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
- <exclude
name="MediaWiki.Commenting.FunctionComment.ExtraParamComment" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
<exclude name="Squiz.Scope.MethodScope.Missing" />
@@ -12,6 +9,4 @@
<file>.</file>
<arg name="extensions" value="php,php5,inc" />
<arg name="encoding" value="UTF-8" />
- <exclude-pattern>vendor</exclude-pattern>
- <exclude-pattern>node_modules</exclude-pattern>
</ruleset>
diff --git a/MolHandler.mime.php b/MolHandler.mime.php
index a581d7e..f0e20d3 100644
--- a/MolHandler.mime.php
+++ b/MolHandler.mime.php
@@ -28,7 +28,6 @@
* Hook: MimeMagicInit.
*
* @param MimeMagic $mimeMagic
- * @param object $addToList Callback function
* @return bool Always true
*/
public static function onMimeMagicInit( $mimeMagic ) {
@@ -84,7 +83,7 @@
*
* @param MimeMagic $mimeMagic
* @param string $ext File extension
- * @param string $mime In: Previously detected MIME; Out: Improved MIME
+ * @param string &$mime In: Previously detected MIME; Out: Improved MIME
* @return bool Always true
*/
public static function onMimeMagicImproveFromExtension( $mimeMagic,
$ext, &$mime ) {
@@ -95,8 +94,8 @@
/**
* Guess chemical MIME types from file content.
*
- * @param string $head 1024 bytes of the head
- * @param string $tail 1024 bytes of the tail
+ * @param string &$head 1024 bytes of the head
+ * @param string &$tail 1024 bytes of the tail
* @param string $file
* @return bool|string Mime type
*/
@@ -154,10 +153,10 @@
* Hook: MimeMagicGuessFromContent.
*
* @param MimeMagic $mimeMagic
- * @param string $head
- * @param string $tail
+ * @param string &$head
+ * @param string &$tail
* @param string $file
- * @param string $mime
+ * @param string &$mime
* @return bool Always true
*/
public static function onMimeMagicGuessFromContent(
diff --git a/MolHandlerHooks.php b/MolHandlerHooks.php
index 76e0e57..92e03a7 100644
--- a/MolHandlerHooks.php
+++ b/MolHandlerHooks.php
@@ -2,7 +2,7 @@
class MolHandlerHooks {
/**
* Hook to add unit tests
- * @param array $files list of testcases
+ * @param array &$files list of testcases
* @return bool
*/
public static function onUnitTestsList( array &$files ) {
--
To view, visit https://gerrit.wikimedia.org/r/403723
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ieb0b5e4f58fccbf8e8376e56023488b3d2b87ee6
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/MolHandler
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Rillke <ril...@wikipedia.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
