Thiemo Mättig (WMDE) has uploaded a new change for review.
https://gerrit.wikimedia.org/r/244124
Change subject: Fix and add missing PHPDoc tags
......................................................................
Fix and add missing PHPDoc tags
Change-Id: Id94cd1a63626eb4eb8a9957f271d1d4ddd804731
---
M includes/WikidataPageBanner.functions.php
M includes/WikidataPageBanner.hooks.php
M tests/phpunit/BannerOptionsTest.php
M tests/phpunit/BannerTest.php
4 files changed, 18 insertions(+), 9 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/WikidataPageBanner
refs/changes/24/244124/1
diff --git a/includes/WikidataPageBanner.functions.php
b/includes/WikidataPageBanner.functions.php
index 5d3cc9d..c428ecb 100644
--- a/includes/WikidataPageBanner.functions.php
+++ b/includes/WikidataPageBanner.functions.php
@@ -173,7 +173,8 @@
* image name. Additionally, if a width parameter is specified, it
creates
* and returns url of an image of specified width.
*
- * @param string $filename Filename of the banner image
+ * @param string $filename Filename of the banner image
+ * @param int|null $imagewidth
* @return string|null Full url of the banner image on the wiki or null
*/
public static function getImageUrl( $filename, $imagewidth = null ) {
diff --git a/includes/WikidataPageBanner.hooks.php
b/includes/WikidataPageBanner.hooks.php
index d90b587..93c06ac 100644
--- a/includes/WikidataPageBanner.hooks.php
+++ b/includes/WikidataPageBanner.hooks.php
@@ -25,7 +25,8 @@
/**
* Expands icons for rendering via template
*
- * @param Array[] $icons of options for IconWidget
+ * @param array[] $icons of options for IconWidget
+ * @return array[]
*/
protected static function expandIconTemplateOptions( array $icons ) {
foreach ( $icons as $key => $iconData ) {
@@ -64,7 +65,7 @@
* or a default one.
*
* @param OutputPage $out
- * @param Skin Skin object being rendered
+ * @param Skin $skin Skin object being rendered
* @return bool
*/
public static function addBanner( OutputPage $out, Skin $skin ) {
@@ -307,8 +308,8 @@
* Register QUnit tests.
* @see
https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderTestModules
*
- * @param array $files
- * @return bool
+ * @param array[] &$modules
+ * @param ResourceLoader &$rl
*/
public static function onResourceLoaderTestModules( &$modules, &$rl ) {
$boilerplate = array(
diff --git a/tests/phpunit/BannerOptionsTest.php
b/tests/phpunit/BannerOptionsTest.php
index 3ff4ed9..d098de0 100644
--- a/tests/phpunit/BannerOptionsTest.php
+++ b/tests/phpunit/BannerOptionsTest.php
@@ -143,8 +143,10 @@
}
/**
- * Helper function for testCustomBanner
- * @return Parser Parser object associated with test pages
+ * Helper function for self::testBannerOptions.
+ * @param string $title
+ * @param int $namespace
+ * @return Parser Parser object associated with test pages
*/
protected function createParser( $title, $namespace ) {
$parser = $this->getMock( 'Parser' );
diff --git a/tests/phpunit/BannerTest.php b/tests/phpunit/BannerTest.php
index a6d5590..4741d91 100644
--- a/tests/phpunit/BannerTest.php
+++ b/tests/phpunit/BannerTest.php
@@ -107,7 +107,10 @@
/**
* Helper function for testDefaultBanner
- * @return Article Article object representing test pages
+ * @param string $title
+ * @param int $namespace
+ * @param string $customBanner
+ * @return OutputPage
*/
protected function createPage( $title, $namespace, $customBanner ) {
$context = new RequestContext();
@@ -125,7 +128,9 @@
/**
* Helper function for testCustomBanner
- * @return Parser Parser object associated with test pages
+ * @param string $title
+ * @param int $namespace
+ * @return Parser Parser object associated with test pages
*/
protected function createParser( $title, $namespace ) {
$parser = $this->getMock( 'Parser' );
--
To view, visit https://gerrit.wikimedia.org/r/244124
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Id94cd1a63626eb4eb8a9957f271d1d4ddd804731
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/WikidataPageBanner
Gerrit-Branch: master
Gerrit-Owner: Thiemo Mättig (WMDE) <thiemo.maet...@wikimedia.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
