jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/403224 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: Idd55d52910550e18b2cea40970c9bdfb9511cb47
---
M .phpcs.xml
M ApexTemplate.php
M SkinApex.php
3 files changed, 11 insertions(+), 12 deletions(-)
Approvals:
jenkins-bot: Verified
Jforrester: Looks good to me, approved
diff --git a/.phpcs.xml b/.phpcs.xml
index 76de051..55ab46e 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -8,8 +8,7 @@
<exclude name="PSR2.Classes.PropertyDeclaration.VarUsed" />
<exclude name="Squiz.Scope.MemberVarScope.Missing" />
<exclude name="Squiz.Scope.MethodScope.Missing" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag"/>
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamName"/>
+ <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment"/>
<exclude
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment"/>
<exclude name="MediaWiki.Usage.ReferenceThis.Found"/>
</rule>
diff --git a/ApexTemplate.php b/ApexTemplate.php
index 9c14d6c..a9c83e2 100644
--- a/ApexTemplate.php
+++ b/ApexTemplate.php
@@ -164,7 +164,7 @@
/**
* Render a series of portals
*
- * @param $portals array
+ * @param array $portals
*/
protected function renderPortals( $portals ) {
// Force the rendering of the following portals
@@ -201,10 +201,10 @@
}
/**
- * @param $name string
- * @param $content array
- * @param $msg null|string
- * @param $hook null|string|array
+ * @param string $name
+ * @param array $content
+ * @param null|string $msg
+ * @param null|string|array $hook
*/
protected function renderPortal( $name, $content, $msg = null, $hook =
null ) {
if ( $msg === null ) {
@@ -247,7 +247,7 @@
* Render one or more navigations elements by name, automatically
reveresed
* when UI is in RTL mode
*
- * @param $elements array
+ * @param array $elements
*/
protected function renderNavigation( $elements ) {
// If only one element was given, wrap it in an array, allowing
more
diff --git a/SkinApex.php b/SkinApex.php
index 05b6e0d..0618484 100644
--- a/SkinApex.php
+++ b/SkinApex.php
@@ -13,7 +13,7 @@
/**
* Initializes output page and sets up skin-specific parameters
- * @param $out OutputPage object to initialize
+ * @param OutputPage $out OutputPage object to initialize
*/
public function initPage( OutputPage $out ) {
global $wgLocalStylePath;
@@ -40,7 +40,7 @@
/**
* Load skin and user CSS files in the correct order
* fixes bug 22916
- * @param $out OutputPage object
+ * @param OutputPage $out OutputPage object
*/
function setupSkinUserCss( OutputPage $out ) {
parent::setupSkinUserCss( $out );
@@ -53,8 +53,8 @@
/**
* Adds classes to the body element.
*
- * @param $out OutputPage object
- * @param &$bodyAttrs Array of attributes that will be set on the body
element
+ * @param OutputPage $out OutputPage object
+ * @param array &$bodyAttrs Array of attributes that will be set on the
body element
*/
function addToBodyAttributes( $out, &$bodyAttrs ) {
if ( isset( $bodyAttrs['class'] ) && strlen(
$bodyAttrs['class'] ) > 0 ) {
--
To view, visit https://gerrit.wikimedia.org/r/403224
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: Idd55d52910550e18b2cea40970c9bdfb9511cb47
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/skins/apex
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <[email protected]>
Gerrit-Reviewer: Jforrester <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
