Dereckson has uploaded a new change for review.
https://gerrit.wikimedia.org/r/97172
Change subject: Improving functions documentation
......................................................................
Improving functions documentation
Change-Id: I1d316df98a2157b9f5593eaf4c7f9587d22796a7
---
M MultimediaViewerHooks.php
1 file changed, 10 insertions(+), 6 deletions(-)
git pull
ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MultimediaViewer
refs/changes/72/97172/1
diff --git a/MultimediaViewerHooks.php b/MultimediaViewerHooks.php
index d72dabb..5eca70e 100644
--- a/MultimediaViewerHooks.php
+++ b/MultimediaViewerHooks.php
@@ -31,7 +31,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 The OutputPage object
* @return bool
*/
protected static function getModules( &$out ) {
@@ -49,8 +49,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 The OutputPage object
+ * @param Skin $skin The Skin object that will be used to generate the
page
* @return bool
*/
public static function getModulesForArticle( &$out, &$skin ) {
@@ -64,7 +64,7 @@
/**
* Handler for CategoryPageView hook
* Add JavaScript to the page if there are images in the category
- * @param CategoryPage $catPage
+ * @param CategoryPage $catPage The CategoryPage instance (CategoryPage
is a subclass of Article)
* @return bool
*/
public static function getModulesForCategory( &$catPage ) {
@@ -78,7 +78,11 @@
return true;
}
- // Add a beta preference to gate the feature
+ /**
+ * Add a beta preference to gate the feature
+ * @param User $user The user who has requested or saved their
preferences
+ * @param &$prefs List of options
+ */
public static function getBetaPreferences( $user, &$prefs ) {
global $wgExtensionAssetsPath;
@@ -95,7 +99,7 @@
/**
* Export variables used in both PHP and JS to keep DRY
- * @param array $vars
+ * @param array $vars Array of variables to be added into the output of
the startup module
* @return bool
*/
public static function resourceLoaderGetConfigVars( &$vars ) {
--
To view, visit https://gerrit.wikimedia.org/r/97172
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I1d316df98a2157b9f5593eaf4c7f9587d22796a7
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/MultimediaViewer
Gerrit-Branch: master
Gerrit-Owner: Dereckson <dereck...@espace-win.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
