jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/382941 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I13c5e62bfbf269b611085fd308349b823f85faf9
---
M LabeledSectionTransclusion.class.php
M phpcs.xml
2 files changed, 29 insertions(+), 33 deletions(-)
Approvals:
Legoktm: Looks good to me, approved
jenkins-bot: Verified
diff --git a/LabeledSectionTransclusion.class.php
b/LabeledSectionTransclusion.class.php
index 25d75ea..8a5eaeb 100644
--- a/LabeledSectionTransclusion.class.php
+++ b/LabeledSectionTransclusion.class.php
@@ -5,7 +5,7 @@
private static $loopCheck = [];
/**
- * @param $parser Parser
+ * @param Parser $parser
* @return bool
*/
static function setup( $parser ) {
@@ -20,8 +20,8 @@
/**
* Add the magic words - possibly with more readable aliases
*
- * @param $magicWords array
- * @param $langCode string
+ * @param array &$magicWords
+ * @param string $langCode
* @return bool
*/
static function setupMagic( &$magicWords, $langCode ) {
@@ -66,8 +66,8 @@
/**
* Register what we're working on in the parser, so we don't fall into
a trap.
- * @param $parser Parser
- * @param $part1
+ * @param Parser $parser
+ * @param string $part1
* @return bool
*/
static function open_( $parser, $part1 ) {
@@ -83,8 +83,8 @@
/**
* Finish processing the function.
- * @param $parser Parser
- * @param $part1
+ * @param Parser $parser
+ * @param string $part1
* @return bool
*/
static function close_( $parser, $part1 ) {
@@ -229,8 +229,8 @@
*
* @param Parser $parser
* @param string $page title text of target page
- * @param (out) Title $title normalized title object
- * @param (out) string $text wikitext output
+ * @param Title &$title normalized title object
+ * @param string &$text wikitext output
* @return string bool true if returning text, false if target not found
* @private
*/
@@ -259,10 +259,10 @@
/**
* Set up some variables for MW-1.12 parser functions
- * @param $parser Parser
- * @param $frame PPFrame
- * @param $args array
- * @param $func string
+ * @param Parser $parser
+ * @param PPFrame $frame
+ * @param array $args
+ * @param string $func
* @return array|string
*/
static function setupPfunc12( $parser, $frame, $args, $func = 'lst' ) {
@@ -319,6 +319,8 @@
/**
* Returns true if the given extension name is "section"
+ * @param string $name
+ * @return bool
*/
static function isSection( $name ) {
global $wgLstLocal;
@@ -329,9 +331,9 @@
/**
* Returns the text for the inside of a split <section> node
- * @param $parser Parser
- * @param $frame PPFrame
- * @param $parts array
+ * @param Parser $parser
+ * @param PPFrame $frame
+ * @param array $parts
* @return string
*/
static function expandSectionNode( $parser, $frame, $parts ) {
@@ -343,9 +345,9 @@
}
/**
- * @param $parser Parser
- * @param $frame PPFrame
- * @param $args array
+ * @param Parser $parser
+ * @param PPFrame $frame
+ * @param array $args
* @return array|string
*/
static function pfuncIncludeObj( $parser, $frame, $args ) {
@@ -427,9 +429,9 @@
}
/**
- * @param $parser Parser
- * @param $frame PPFrame
- * @param $args array
+ * @param Parser $parser
+ * @param PPFrame $frame
+ * @param array $args
* @return array|string
*/
static function pfuncExcludeObj( $parser, $frame, $args ) {
@@ -506,10 +508,10 @@
*
* @todo: MW 1.12 version, as per #lst/#lstx
*
- * @param $parser Parser
- * @param $page string
- * @param $sec string
- * @param $to string
+ * @param Parser $parser
+ * @param string $page
+ * @param string $sec
+ * @param string $to
* @return mixed|string
*/
static function pfuncIncludeHeading( $parser, $page = '', $sec = '',
$to = '' ) {
diff --git a/phpcs.xml b/phpcs.xml
index 2a5d54d..d531208 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,17 +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.MissingReturn" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude
name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
<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/382941
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I13c5e62bfbf269b611085fd308349b823f85faf9
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/LabeledSectionTransclusion
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Jackmcbarn <jackmcb...@gmail.com>
Gerrit-Reviewer: Legoktm <lego...@member.fsf.org>
Gerrit-Reviewer: Merlijn van Deen <valhall...@arctus.nl>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
