Umherirrender has uploaded a new change for review. ( 
https://gerrit.wikimedia.org/r/402641 )

Change subject: Improve some parameter docs
......................................................................

Improve some parameter docs

Change-Id: I1cc6e7812ebf890f14a6621426bf31c1d507d8d5
---
M .phpcs.xml
M ProjectHandler.php
M ResourceLoaderProjectIconsModule.php
M specials/SpecialTwnMainPage.php
4 files changed, 15 insertions(+), 11 deletions(-)


  git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/TwnMainPage 
refs/changes/41/402641/1

diff --git a/.phpcs.xml b/.phpcs.xml
index 7fca01b..cb6203b 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -3,17 +3,11 @@
        <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
                <exclude 
name="Generic.Files.OneObjectStructurePerFile.MultipleFound" />
                <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.Files.ClassMatchesFilename.NotMatch" />
                <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
                <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>
+       <arg name="encoding" value="UTF-8" />
 </ruleset>
diff --git a/ProjectHandler.php b/ProjectHandler.php
index e53523b..0dac29f 100644
--- a/ProjectHandler.php
+++ b/ProjectHandler.php
@@ -45,7 +45,7 @@
        /**
         * Sort the projects by to be determined algorithm. Like most sorting
         * functions in PHP this modifies passed list in place.
-        * @param MessageGroup[] $groups
+        * @param MessageGroup[] &$groups
         * @param string $language Language code.
         * @param array $stats Message group stats.
         */
diff --git a/ResourceLoaderProjectIconsModule.php 
b/ResourceLoaderProjectIconsModule.php
index 9b80382..703210d 100644
--- a/ResourceLoaderProjectIconsModule.php
+++ b/ResourceLoaderProjectIconsModule.php
@@ -33,7 +33,7 @@
 
        /**
         * @see also resouces/css/ext.translate.mainpage.css
-        * @param $context ResourceLoaderContext
+        * @param ResourceLoaderContext $context
         * @return array CSS styles
         */
        public function getStyles( ResourceLoaderContext $context ) {
diff --git a/specials/SpecialTwnMainPage.php b/specials/SpecialTwnMainPage.php
index 29e75ef..5db4730 100644
--- a/specials/SpecialTwnMainPage.php
+++ b/specials/SpecialTwnMainPage.php
@@ -433,7 +433,11 @@
                return $count;
        }
 
-       // Callback for CachedStat
+       /**
+        * Callback for CachedStat
+        * @param ProjectHandler $handler
+        * @return array
+        */
        public static function getTwnStats( ProjectHandler $handler ) {
                $projects = count( $handler->getProjects() );
                $translators = SiteStats::numberingroup( 'translator' );
@@ -448,7 +452,12 @@
                ];
        }
 
-       // Callback for CachedStat
+       /**
+        * Callback for CachedStat
+        * @param string $code
+        * @param int $period
+        * @return array
+        */
        public static function getUserStats( $code, $period ) {
                return [
                        'translators' => TwnUserStats::getTranslationRankings( 
$code, $period ),
@@ -533,6 +542,7 @@
 
        /**
         * Form that allows users to signup via sandbox.
+        * @return true
         */
        public function loginForm() {
                $this->getOutput()->addModules( 'ext.translate.mainpage.signup' 
);

-- 
To view, visit https://gerrit.wikimedia.org/r/402641
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I1cc6e7812ebf890f14a6621426bf31c1d507d8d5
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/TwnMainPage
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to