jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/403729 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I11cdca3812a6bb6d93ffbc916a632b6589ca70b9
---
M .phpcs.xml
M includes/AJAXPoll.class.php
2 files changed, 10 insertions(+), 7 deletions(-)
Approvals:
Umherirrender: Looks good to me, approved
jenkins-bot: Verified
diff --git a/.phpcs.xml b/.phpcs.xml
index bd7b626..3a6373b 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -2,9 +2,6 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
- <exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle"
/>
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
@@ -15,6 +12,5 @@
</rule>
<file>.</file>
<arg name="extensions" value="php,php5,inc" />
- <arg name="encoding" value="utf8" />
- <exclude-pattern>vendor</exclude-pattern>
+ <arg name="encoding" value="UTF-8" />
</ruleset>
diff --git a/includes/AJAXPoll.class.php b/includes/AJAXPoll.class.php
index cc22178..8c8c2c6 100644
--- a/includes/AJAXPoll.class.php
+++ b/includes/AJAXPoll.class.php
@@ -18,7 +18,7 @@
/**
* Register <poll> tag with the parser
*
- * @param parser Parser (not necessarily $wgParser
+ * @param Parser $parser A parser instance, not necessarily $wgParser
* @return bool true
*/
static function onParserInit( $parser ) {
@@ -27,7 +27,14 @@
return true;
}
- # The callback function for converting the input text to HTML output
+ /**
+ * The callback function for converting the input text to HTML output
+ * @param string $input
+ * @param array $args
+ * @param Parser $parser
+ * @param PPFrame $frame
+ * @return string
+ */
static function AJAXPollRender( $input, $args = [], Parser $parser,
$frame ) {
global $wgUser, $wgRequest, $wgUseAjax;
--
To view, visit https://gerrit.wikimedia.org/r/403729
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I11cdca3812a6bb6d93ffbc916a632b6589ca70b9
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/AJAXPoll
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
