From 8e8c9d0654a73a825b9edbb9910ed86d96f8bac3 Mon Sep 17 00:00:00 2001
From: Umherirrender <umherirrender_de.wp@web.de>
Date: Thu, 5 Oct 2017 19:17:38 +0200
Subject: [PATCH] Improve some parameter docs

Change-Id: I239d4aa0023978b27bc04a7ff7d55892f3bb7feb
---
 includes/Minerva.hooks.php         | 6 +++---
 includes/skins/MenuBuilder.php     | 8 ++++----
 includes/skins/MinervaTemplate.php | 7 ++++++-
 includes/skins/SkinMinerva.php     | 4 ++--
 phpcs.xml                          | 5 -----
 5 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/includes/Minerva.hooks.php b/includes/Minerva.hooks.php
index 334f002..526c5f1 100644
--- a/includes/Minerva.hooks.php
+++ b/includes/Minerva.hooks.php
@@ -45,8 +45,8 @@ class MinervaHooks {
 	 * ResourceLoaderTestModules hook handler
 	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderTestModules
 	 *
-	 * @param array $testModules
-	 * @param ResourceLoader $resourceLoader
+	 * @param array &$testModules
+	 * @param ResourceLoader &$resourceLoader
 	 * @return bool
 	 */
 	public static function onResourceLoaderTestModules( array &$testModules,
@@ -124,7 +124,7 @@ class MinervaHooks {
 	/**
 	 * BeforePageDisplayMobile hook handler.
 	 *
-	 * @param OutputPage $out
+	 * @param MobileContext $mobileContext
 	 * @param Skin $skin
 	 */
 	public static function onRequestContextCreateSkinMobile(
diff --git a/includes/skins/MenuBuilder.php b/includes/skins/MenuBuilder.php
index 9672912..b03db26 100644
--- a/includes/skins/MenuBuilder.php
+++ b/includes/skins/MenuBuilder.php
@@ -39,7 +39,7 @@ class MenuBuilder {
 	 * Insert an entry into the menu.
 	 *
 	 * @param string $name A unique name identifying the menu entry
-	 * @param bool [ $isJSOnly] Whether the menu entry works without JS
+	 * @param bool $isJSOnly Whether the menu entry works without JS
 	 * @throws DomainException When the entry already exists
 	 * @return MenuEntry
 	 */
@@ -77,7 +77,7 @@ class MenuBuilder {
 	 * @param string $targetName The name of the existing entry to insert
 	 *  the new entry after
 	 * @param string $name The name of the new entry
-	 * @param bool [ $isJSOnly] Whether the entry works without JS
+	 * @param bool $isJSOnly Whether the entry works without JS
 	 * @throws DomainException When the existing entry doesn't exist
 	 * @return MenuEntry
 	 */
@@ -148,9 +148,9 @@ class MenuEntry {
 	 *
 	 * @param string $label
 	 * @param string $url
-	 * @param string [ $className] Any additional CSS classes that should added to the output,
+	 * @param string $className Any additional CSS classes that should added to the output,
 	 *  separated by spaces
-	 * @param array [ $attrs] Additional data that can be associated with the component
+	 * @param array $attrs Additional data that can be associated with the component
 	 *
 	 * @return MenuEntry
 	 */
diff --git a/includes/skins/MinervaTemplate.php b/includes/skins/MinervaTemplate.php
index c6853f3..d747916 100644
--- a/includes/skins/MinervaTemplate.php
+++ b/includes/skins/MinervaTemplate.php
@@ -126,12 +126,17 @@ class MinervaTemplate extends BaseTemplate {
 		}
 	}
 
+	/**
+	 * @return bool
+	 */
 	protected function isFallbackEditor() {
 		$action = $this->getSkin()->getRequest()->getVal( 'action' );
 		return $action === 'edit';
 	}
+
 	/**
 	 * Get page secondary actions
+	 * @return string[]
 	 */
 	protected function getSecondaryActions() {
 		if ( $this->isFallbackEditor() ) {
@@ -242,7 +247,7 @@ class MinervaTemplate extends BaseTemplate {
 	/**
 	 * Gets the main menu only on Special:MobileMenu.
 	 * On other pages the menu is rendered via JS.
-	 * @param array [ $data] Data used to build the page
+	 * @param array $data Data used to build the page
 	 * @return string
 	 */
 	protected function getMainMenuHtml( $data ) {
diff --git a/includes/skins/SkinMinerva.php b/includes/skins/SkinMinerva.php
index d6b6e14..22459c1 100644
--- a/includes/skins/SkinMinerva.php
+++ b/includes/skins/SkinMinerva.php
@@ -1270,7 +1270,7 @@ class SkinMinerva extends SkinTemplate implements ICustomizableSkin {
 			$this->getUser()->isLoggedIn();
 	}
 
-	/*
+	/**
 	 * Returns true, if the talk page of this page is wikitext-based.
 	 * @return bool
 	 */
@@ -1379,7 +1379,7 @@ class SkinMinerva extends SkinTemplate implements ICustomizableSkin {
 	 * property.
 	 *
 	 * @param OutputPage $out
-	 * @param array $bodyAttrs
+	 * @param array &$bodyAttrs
 	 */
 	public function addToBodyAttributes( $out, &$bodyAttrs ) {
 		$classes = $out->getProperty( 'bodyClassName' );
diff --git a/phpcs.xml b/phpcs.xml
index a249e12..953883a 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -3,14 +3,9 @@
 	<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
 		<exclude name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName"/>
 		<exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment"/>
-		<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamTag"/>
 		<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamComment"/>
-		<exclude name="MediaWiki.Commenting.FunctionComment.WrongStyle" />
 		<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
 		<exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
-		<exclude name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch"/>
-		<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected"/>
-		<exclude name="MediaWiki.Commenting.FunctionComment.MissingReturn"/>
 	</rule>
 	<file>.</file>
 	<arg name="extensions" value="php,php5,inc"/>