jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/382983 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Ice6637dddcbab358411acd3698a11571cd8dcd6d
---
M Hooks.php
M includes/Block/Block.php
M includes/Formatter/RevisionViewQuery.php
M includes/Import/Importer.php
M includes/Import/OptInController.php
M includes/Notifications/Controller.php
M includes/Parsoid/Fixer/BaseHrefFixer.php
M includes/RevisionActionPermissions.php
M maintenance/convertAllLqtPages.php
M phpcs.xml
M tests/phpunit/Mock/MockImportSource.php
11 files changed, 17 insertions(+), 18 deletions(-)
Approvals:
Legoktm: Looks good to me, approved
jenkins-bot: Verified
diff --git a/Hooks.php b/Hooks.php
index 77ee258..0da15c1 100644
--- a/Hooks.php
+++ b/Hooks.php
@@ -860,7 +860,7 @@
/**
* Adds Flow contributions to the DeletedContributions special page
*
- * @param array $data an array of results of all contribs queries, to be
+ * @param array &$data an array of results of all contribs queries, to
be
* merged to form all contributions data
* @param ContribsPager $pager Object hooked into
* @param string $offset Index offset, inclusive
@@ -893,7 +893,7 @@
/**
* Adds Flow contributions to the Contributions special page
*
- * @param array $data an array of results of all contribs queries, to be
+ * @param array &$data an array of results of all contribs queries, to
be
* merged to form all contributions data
* @param ContribsPager $pager Object hooked into
* @param string $offset Index offset, inclusive
@@ -912,7 +912,7 @@
/**
* Define and add descriptions for board-related variables
- * @param array $realValues
+ * @param array &$realValues
* @return bool
*/
public static function onAbuseFilterBuilder( &$realValues ) {
diff --git a/includes/Block/Block.php b/includes/Block/Block.php
index 5fab019..cae569f 100644
--- a/includes/Block/Block.php
+++ b/includes/Block/Block.php
@@ -187,7 +187,7 @@
* Get the template name for a specific action or an array of template
* for all possible view actions in this block
*
- * @param string|null
+ * @param string|null $action
* @return string|array
* @throws InvalidInputException
*/
diff --git a/includes/Formatter/RevisionViewQuery.php
b/includes/Formatter/RevisionViewQuery.php
index c32902f..21a3c83 100644
--- a/includes/Formatter/RevisionViewQuery.php
+++ b/includes/Formatter/RevisionViewQuery.php
@@ -34,14 +34,14 @@
/**
* Create a revision based on revisionId
- * @param UUID|string
+ * @param UUID|string $revId
* @return AbstractRevision
*/
abstract protected function createRevision( $revId );
/**
* Get the data for rendering single revision view
- * @param string
+ * @param string $revId
* @return FormatterRow
* @throws InvalidInputException
*/
diff --git a/includes/Import/Importer.php b/includes/Import/Importer.php
index e1eda67..66a2382 100644
--- a/includes/Import/Importer.php
+++ b/includes/Import/Importer.php
@@ -103,7 +103,7 @@
*
* @param IImportSource $source
* @param Title $targetPage
- * @param User User doing the conversion actions (e.g. initial
description,
+ * @param User $user User doing the conversion actions (e.g. initial
description,
* wikitext archive edit). However, actions will be attributed to
the original
* user when possible (e.g. the user who did the original LQT reply)
* @param ImportSourceStore $sourceStore
diff --git a/includes/Import/OptInController.php
b/includes/Import/OptInController.php
index c7c430e..6630302 100644
--- a/includes/Import/OptInController.php
+++ b/includes/Import/OptInController.php
@@ -165,7 +165,7 @@
}
/**
- * @param $msgKey
+ * @param string $msgKey
* @param array $args
* @throws ImportException
*/
@@ -248,7 +248,7 @@
/**
* @param Title $title
- * @param $boardDescription
+ * @param string $boardDescription
* @throws ImportException
* @throws \Flow\Exception\CrossWikiException
* @throws \Flow\Exception\InvalidInputException
@@ -544,7 +544,7 @@
/**
* @param Title $title
- * @param $reason
+ * @param string $reason
* @param callable $newDescriptionCallback
* @param string $format
* @throws ImportException
diff --git a/includes/Notifications/Controller.php
b/includes/Notifications/Controller.php
index 62477dc..a78f9aa 100644
--- a/includes/Notifications/Controller.php
+++ b/includes/Notifications/Controller.php
@@ -668,7 +668,7 @@
* Handler for EchoGetBundleRule hook, which defines the bundle rules
for each notification
*
* @param EchoEvent $event
- * @param string $bundleString Determines how the notification should
be bundled
+ * @param string &$bundleString Determines how the notification should
be bundled
* @return bool True for success
*/
public static function onEchoGetBundleRules( $event, &$bundleString ) {
@@ -764,7 +764,7 @@
* This is the lowest-number post, numbering them using a pre-order
depth-first
* search
*
- * @param array Array of EchoEvents
+ * @param array $bundledEvents Array of EchoEvents
* @return UUID|null Post ID, or null on failure
*/
public function getTopmostPostId( array $bundledEvents ) {
diff --git a/includes/Parsoid/Fixer/BaseHrefFixer.php
b/includes/Parsoid/Fixer/BaseHrefFixer.php
index 536e9ad..4db424c 100644
--- a/includes/Parsoid/Fixer/BaseHrefFixer.php
+++ b/includes/Parsoid/Fixer/BaseHrefFixer.php
@@ -20,7 +20,7 @@
protected $baseHref;
/**
- * @param $articlePath \Article path setting for wiki
+ * @param \Article $articlePath path setting for wiki
*/
public function __construct( $articlePath ) {
$replacedArticlePath = str_replace( '$1', '', $articlePath );
diff --git a/includes/RevisionActionPermissions.php
b/includes/RevisionActionPermissions.php
index 83baaee..0f93582 100644
--- a/includes/RevisionActionPermissions.php
+++ b/includes/RevisionActionPermissions.php
@@ -274,7 +274,7 @@
}
/**
- * @param $user
+ * @param User $user
*/
public function setUser( User $user ) {
$this->user = $user;
diff --git a/maintenance/convertAllLqtPages.php
b/maintenance/convertAllLqtPages.php
index a62d9b7..617a45e 100644
--- a/maintenance/convertAllLqtPages.php
+++ b/maintenance/convertAllLqtPages.php
@@ -79,8 +79,8 @@
}
/**
- * @param $logger
- * @param $dbw
+ * @param AbstractLogger $logger
+ * @param IDatabase $dbw
* @return AppendIterator
*/
private function buildIterator( $logger, $dbw ) {
diff --git a/phpcs.xml b/phpcs.xml
index c45fa36..367d4ae 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -5,7 +5,6 @@
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<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" />
diff --git a/tests/phpunit/Mock/MockImportSource.php
b/tests/phpunit/Mock/MockImportSource.php
index 3a3c90a..5593f2f 100644
--- a/tests/phpunit/Mock/MockImportSource.php
+++ b/tests/phpunit/Mock/MockImportSource.php
@@ -19,7 +19,7 @@
/**
* @param IImportHeader|null $header
- * @param IImportTopic[]
+ * @param IImportTopic[] $topics
*/
public function __construct( MockImportHeader $header = null, array
$topics = [] ) {
$this->topics = $topics;
--
To view, visit https://gerrit.wikimedia.org/r/382983
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Ice6637dddcbab358411acd3698a11571cd8dcd6d
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/Flow
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
Gerrit-Reviewer: Legoktm <lego...@member.fsf.org>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
