Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/384241 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I1bd048a7b3d6738c851e70563f0731ceb6332995
---
M SubPageList3.class.php
M phpcs.xml
2 files changed, 9 insertions(+), 12 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/SubPageList3
refs/changes/41/384241/1
diff --git a/SubPageList3.class.php b/SubPageList3.class.php
index de1e3f9..b120754 100644
--- a/SubPageList3.class.php
+++ b/SubPageList3.class.php
@@ -122,7 +122,7 @@
/**
* Constructor function of the class
- * @param $parser Parser the parser object
+ * @param Parser $parser the parser object
* @global $wgContLang
* @see SubpageList
* @private
@@ -135,7 +135,7 @@
}
/**
- * @param $parser Parser
+ * @param Parser &$parser
* @return bool
*/
public static function onParserFirstCallInit( &$parser ) {
@@ -146,9 +146,9 @@
/**
* Function called by the Hook, returns the wiki text
*
- * @param $input
- * @param $args
- * @param $parser Parser
+ * @param string $input
+ * @param array $args
+ * @param Parser $parser
* @return string
*/
public static function renderSubpageList3( $input, $args, $parser ) {
@@ -391,7 +391,7 @@
* - full: full, e.g. Mainpage/Entry/Sub
* - notparent: the path without the $parent item, e.g. Entry/Sub
* - no: no path, only the page title, e.g. Sub
- * @param $title Title the title of a page
+ * @param Title $title the title of a page
* @return string the prepared string
* @see $showpath
*/
@@ -411,7 +411,7 @@
/**
* create whole list using makeListItem
- * @param $titles Array all page titles
+ * @param array $titles Array all page titles
* @return string the whole list
* @see SubPageList::makeListItem
*/
diff --git a/phpcs.xml b/phpcs.xml
index 51a6bd4..53b90b0 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -1,14 +1,11 @@
<?xml version="1.0"?>
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
+ <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<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/384241
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I1bd048a7b3d6738c851e70563f0731ceb6332995
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/SubPageList3
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
