jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/382980 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Id84edc2b38bf94724817e0b119aa27ea11341acb
---
M MultimediaViewerHooks.php
M phpcs.xml
2 files changed, 23 insertions(+), 19 deletions(-)
Approvals:
Legoktm: Looks good to me, approved
jenkins-bot: Verified
diff --git a/MultimediaViewerHooks.php b/MultimediaViewerHooks.php
index 1064de3..9b261cd 100644
--- a/MultimediaViewerHooks.php
+++ b/MultimediaViewerHooks.php
@@ -206,7 +206,7 @@
/**
* Handler for all places where we add the modules
* Could be on article pages or on Category pages
- * @param OutputPage $out
+ * @param OutputPage &$out
* @return bool
*/
protected static function getModules( &$out ) {
@@ -219,8 +219,8 @@
* Handler for BeforePageDisplay hook
* Add JavaScript to the page when an image is on it
* and the user has enabled the feature if BetaFeatures is installed
- * @param OutputPage $out
- * @param Skin $skin
+ * @param OutputPage &$out
+ * @param Skin &$skin
* @return bool
*/
public static function getModulesForArticle( &$out, &$skin ) {
@@ -241,7 +241,7 @@
/**
* Handler for CategoryPageView hook
* Add JavaScript to the page if there are images in the category
- * @param CategoryPage $catPage
+ * @param CategoryPage &$catPage
* @return bool
*/
public static function getModulesForCategory( &$catPage ) {
@@ -255,7 +255,12 @@
return true;
}
- // Add a beta preference to gate the feature
+ /**
+ * Add a beta preference to gate the feature
+ * @param User $user
+ * @param array &$prefs
+ * @return true
+ */
public static function getBetaPreferences( $user, &$prefs ) {
global $wgExtensionAssetsPath, $wgMediaViewerIsInBeta;
@@ -278,7 +283,12 @@
return true;
}
- // Adds a default-enabled preference to gate the feature on non-beta
sites
+ /**
+ * Adds a default-enabled preference to gate the feature on non-beta
sites
+ * @param User $user
+ * @param array &$prefs
+ * @return true
+ */
public static function getPreferences( $user, &$prefs ) {
global $wgMediaViewerIsInBeta;
@@ -295,7 +305,7 @@
/**
* Export variables used in both PHP and JS to keep DRY
- * @param array $vars
+ * @param array &$vars
* @return bool
*/
public static function resourceLoaderGetConfigVars( &$vars ) {
@@ -332,7 +342,7 @@
/**
* Export variables which depend on the current user
- * @param $vars
+ * @param array &$vars
* @param OutputPage $out
*/
public static function makeGlobalVariablesScript( &$vars, OutputPage
$out ) {
@@ -347,7 +357,7 @@
/**
* Get modules for testing our JavaScript
- * @param array $testModules
+ * @param array &$testModules
* @param ResourceLoader &$resourceLoader
* @return bool
*/
@@ -424,8 +434,9 @@
/**
* Modify thumbnail DOM
* @param ThumbnailImage $thumbnail
- * @param array $attribs Attributes of the <img> element
- * @param array|bool $linkAttribs Attributes of the wrapping <a> element
+ * @param array &$attribs Attributes of the <img> element
+ * @param array|bool &$linkAttribs Attributes of the wrapping <a>
element
+ * @return true
*/
public static function thumbnailBeforeProduceHTML( ThumbnailImage
$thumbnail, array &$attribs,
&$linkAttribs
diff --git a/phpcs.xml b/phpcs.xml
index 14a2095..6cc1952 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -2,16 +2,9 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<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.WrongStyle"
/>
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
</rule>
<file>.</file>
<arg name="extensions" value="php,php5,inc" />
- <arg name="encoding" value="utf8" />
- <exclude-pattern>vendor</exclude-pattern>
- <exclude-pattern>node_modules</exclude-pattern>
+ <arg name="encoding" value="UTF-8" />
</ruleset>
--
To view, visit https://gerrit.wikimedia.org/r/382980
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Id84edc2b38bf94724817e0b119aa27ea11341acb
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/MultimediaViewer
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
