jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/382747 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ic1f97e5cfa0ba19604a021ffa585d2f4a3fc6bf3
---
M BetaFeaturesHooks.php
M includes/ApiListBetaFeatures.php
M includes/HTMLFeatureField.php
M includes/HTMLTextBlockField.php
M includes/NewHTMLCheckField.php
M phpcs.xml
6 files changed, 9 insertions(+), 11 deletions(-)
Approvals:
jenkins-bot: Verified
Jforrester: Looks good to me, approved
diff --git a/BetaFeaturesHooks.php b/BetaFeaturesHooks.php
index 01b8ff1..c3a1ab2 100644
--- a/BetaFeaturesHooks.php
+++ b/BetaFeaturesHooks.php
@@ -100,7 +100,7 @@
/**
* @param User $user
- * @param array $prefs
+ * @param array &$prefs
* @return bool
* @throws BetaFeaturesMissingFieldException
*/
@@ -300,7 +300,7 @@
}
/**
- * @param array $personal_urls
+ * @param array &$personal_urls
* @param Title $title
* @param SkinTemplate $skintemplate
* @return bool
diff --git a/includes/ApiListBetaFeatures.php b/includes/ApiListBetaFeatures.php
index 533f448..5c29cd5 100644
--- a/includes/ApiListBetaFeatures.php
+++ b/includes/ApiListBetaFeatures.php
@@ -67,6 +67,7 @@
/**
* @see ApiBase::getExamplesMessages()
+ * @return array
*/
protected function getExamplesMessages() {
return [
diff --git a/includes/HTMLFeatureField.php b/includes/HTMLFeatureField.php
index a824833..d40ab6f 100644
--- a/includes/HTMLFeatureField.php
+++ b/includes/HTMLFeatureField.php
@@ -315,6 +315,8 @@
/**
* Override to use integers, so we don't lose the database rows on
* unset...
+ * @param WebRequest $request
+ * @return string
*/
function loadDataFromRequest( $request ) {
$res = parent::loadDataFromRequest( $request );
diff --git a/includes/HTMLTextBlockField.php b/includes/HTMLTextBlockField.php
index 7c0f5bc..58a637f 100644
--- a/includes/HTMLTextBlockField.php
+++ b/includes/HTMLTextBlockField.php
@@ -27,6 +27,7 @@
/**
* Override __construct so we can allow HTML in labels
+ * @param array $params
*/
function __construct( $params ) {
if ( isset( $params['label'] ) ) {
diff --git a/includes/NewHTMLCheckField.php b/includes/NewHTMLCheckField.php
index e571313..17a59fb 100644
--- a/includes/NewHTMLCheckField.php
+++ b/includes/NewHTMLCheckField.php
@@ -33,8 +33,8 @@
// Override these in subclasses (see HTMLFeatureField, e.g.)
/**
- * @param $value
- * @param $attr
+ * @param string $value
+ * @param string $attr
* @return string
*/
protected function getCheckboxHTML( $value, $attr ) {
diff --git a/phpcs.xml b/phpcs.xml
index e614b9e..f0ce77f 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,11 +2,7 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude
name="Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase"
/>
- <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.Commenting.FunctionComment.MissingParamComment" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
@@ -16,6 +12,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>
--
To view, visit https://gerrit.wikimedia.org/r/382747
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ic1f97e5cfa0ba19604a021ffa585d2f4a3fc6bf3
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/BetaFeatures
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <[email protected]>
Gerrit-Reviewer: Jforrester <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
