jenkins-bot has submitted this change and it was merged.
Change subject: Fix broken documentation in Client
......................................................................
Fix broken documentation in Client
... as reported by the PHPStorm code analysis.
Change-Id: I3cfc3dc70432173e75d2b8b9f1aefe0e2b4db77f
---
M client/includes/hooks/BaseTemplateAfterPortletHandler.php
M client/includes/hooks/BeforePageDisplayHandler.php
M client/includes/hooks/SpecialWatchlistQueryHandler.php
M client/resources/jquery.wikibase/jquery.wikibase.linkitem.js
M client/resources/wikibase.client.PageConnector.js
M client/tests/phpunit/includes/ClientSiteLinkLookupTest.php
M client/tests/phpunit/includes/hooks/InfoActionHookHandlerTest.php
M client/tests/phpunit/includes/hooks/SpecialWatchlistQueryHandlerTest.php
8 files changed, 28 insertions(+), 9 deletions(-)
Approvals:
Hoo man: Looks good to me, approved
WikidataJenkins: Verified
jenkins-bot: Verified
diff --git a/client/includes/hooks/BaseTemplateAfterPortletHandler.php
b/client/includes/hooks/BaseTemplateAfterPortletHandler.php
index 0ca3b75..0975b1f 100644
--- a/client/includes/hooks/BaseTemplateAfterPortletHandler.php
+++ b/client/includes/hooks/BaseTemplateAfterPortletHandler.php
@@ -14,7 +14,7 @@
class BaseTemplateAfterPortletHandler {
/**
- * @param BaseTemplate $skinTemplate
+ * @param BaseTemplate $baseTemplate
* @param string $name
*
* @return string|null
diff --git a/client/includes/hooks/BeforePageDisplayHandler.php
b/client/includes/hooks/BeforePageDisplayHandler.php
index 8b932f1..71c3f28 100644
--- a/client/includes/hooks/BeforePageDisplayHandler.php
+++ b/client/includes/hooks/BeforePageDisplayHandler.php
@@ -31,10 +31,11 @@
/**
* @note in php5, $out is by passed by reference (by default, so &$out
is not needed)
*
- * @param OutputPage &$out
+ * @param OutputPage $out
* @param Skin $skin
+ * @param string $actionName
*
- * @return boolean
+ * @return bool
*/
public function addModules( OutputPage $out, Skin $skin, $actionName ) {
$title = $out->getTitle();
diff --git a/client/includes/hooks/SpecialWatchlistQueryHandler.php
b/client/includes/hooks/SpecialWatchlistQueryHandler.php
index 65478b8..5084641 100644
--- a/client/includes/hooks/SpecialWatchlistQueryHandler.php
+++ b/client/includes/hooks/SpecialWatchlistQueryHandler.php
@@ -3,6 +3,7 @@
namespace Wikibase\Client\Hooks;
use DatabaseBase;
+use FormOptions;
use User;
use WebRequest;
@@ -92,7 +93,9 @@
}
/**
- * @return boolean
+ * @param string $cond
+ *
+ * @return bool
*/
private function isRcTypeLogCondition( $cond ) {
return $cond === $this->getRcTypeLogCondition();
@@ -141,7 +144,8 @@
/**
* @param WebRequest $request
- * @return boolean
+ *
+ * @return bool
*/
private function isEnhancedChangesEnabled( WebRequest $request ) {
return $request->getBool( 'enhanced', $this->user->getOption(
'usenewrc' ) ) === true;
diff --git a/client/resources/jquery.wikibase/jquery.wikibase.linkitem.js
b/client/resources/jquery.wikibase/jquery.wikibase.linkitem.js
index 81c8ba5..71637d0 100644
--- a/client/resources/jquery.wikibase/jquery.wikibase.linkitem.js
+++ b/client/resources/jquery.wikibase/jquery.wikibase.linkitem.js
@@ -501,7 +501,7 @@
/**
* Creates a table row for a site link.
*
- * @param {wikibase.Site} site
+ * @param {wb.Site} site
* @param {object} entitySitelinks
*
* @return {jQuery}
diff --git a/client/resources/wikibase.client.PageConnector.js
b/client/resources/wikibase.client.PageConnector.js
index b186594..8a4ccc6 100644
--- a/client/resources/wikibase.client.PageConnector.js
+++ b/client/resources/wikibase.client.PageConnector.js
@@ -112,7 +112,7 @@
*
* @param {object} apiResult
*
- * @return {Object} Entity as returned by the API
+ * @return {object|undefined} Entity as returned by the API
*/
_extractEntity: function( apiResult ) {
for ( var i in apiResult.entities ) {
diff --git a/client/tests/phpunit/includes/ClientSiteLinkLookupTest.php
b/client/tests/phpunit/includes/ClientSiteLinkLookupTest.php
index d22e18e..3a2cda3 100644
--- a/client/tests/phpunit/includes/ClientSiteLinkLookupTest.php
+++ b/client/tests/phpunit/includes/ClientSiteLinkLookupTest.php
@@ -40,6 +40,8 @@
);
/**
+ * @param string $localSiteId
+ *
* @return ClientSiteLinkLookup
*/
private function getClientSiteLinkLookup( $localSiteId ) {
diff --git a/client/tests/phpunit/includes/hooks/InfoActionHookHandlerTest.php
b/client/tests/phpunit/includes/hooks/InfoActionHookHandlerTest.php
index a12a8a7..61813eb 100644
--- a/client/tests/phpunit/includes/hooks/InfoActionHookHandlerTest.php
+++ b/client/tests/phpunit/includes/hooks/InfoActionHookHandlerTest.php
@@ -73,6 +73,9 @@
}
/**
+ * @param bool $enabled
+ * @param ItemId $entityId
+ *
* @return InfoActionHookHandler
*/
private function newHookHandler( $enabled, $entityId ) {
diff --git
a/client/tests/phpunit/includes/hooks/SpecialWatchlistQueryHandlerTest.php
b/client/tests/phpunit/includes/hooks/SpecialWatchlistQueryHandlerTest.php
index 49a4a86..4e12df1 100644
--- a/client/tests/phpunit/includes/hooks/SpecialWatchlistQueryHandlerTest.php
+++ b/client/tests/phpunit/includes/hooks/SpecialWatchlistQueryHandlerTest.php
@@ -4,6 +4,7 @@
use FauxRequest;
use FormOptions;
+use User;
use Wikibase\Client\Hooks\SpecialWatchlistQueryHandler;
/**
@@ -21,7 +22,11 @@
/**
* @dataProvider addWikibaseConditionsProvider
*/
- public function testAddWikibaseConditions( $expected, $conds,
$enhanced, $hideWikibase,
+ public function testAddWikibaseConditions(
+ array $expected,
+ array $conds,
+ $enhanced,
+ $hideWikibase,
$message
) {
$user = $this->getUser( $enhanced );
@@ -52,7 +57,9 @@
}
/**
- * @param boolean $enhanced
+ * @param bool $enhanced
+ *
+ * @return User
*/
private function getUser( $enhanced ) {
$user = $this->getMockBuilder( 'User' )
@@ -84,8 +91,10 @@
return
'(rc_this_oldid=page_latest) OR rc_type IN (3,5)';
}
}
+ return '';
} ) );
return $database;
}
+
}
--
To view, visit https://gerrit.wikimedia.org/r/135416
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I3cfc3dc70432173e75d2b8b9f1aefe0e2b4db77f
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/Wikibase
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de>
Gerrit-Reviewer: Adrian Lang <adrian.l...@wikimedia.de>
Gerrit-Reviewer: Aude <aude.w...@gmail.com>
Gerrit-Reviewer: Daniel Kinzler <daniel.kinz...@wikimedia.de>
Gerrit-Reviewer: Hoo man <h...@online.de>
Gerrit-Reviewer: WikidataJenkins <wikidata-servi...@wikimedia.de>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
