jenkins-bot has submitted this change and it was merged. ( 
https://gerrit.wikimedia.org/r/382489 )

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


Improve some parameter docs

Change-Id: I68c54d34311e83536e7520ad932cddf0449054c4
---
M SkinCologneBlue.php
M phpcs.xml
2 files changed, 19 insertions(+), 5 deletions(-)

Approvals:
  jenkins-bot: Verified
  Jforrester: Looks good to me, approved



diff --git a/SkinCologneBlue.php b/SkinCologneBlue.php
index 4a2b0e7..a48c23e 100644
--- a/SkinCologneBlue.php
+++ b/SkinCologneBlue.php
@@ -55,6 +55,10 @@
 }
 
 class CologneBlueTemplate extends BaseTemplate {
+
+       /**
+        * Run the skin and build html
+        */
        function execute() {
                // Suppress warnings to prevent notices about missing indexes 
in $this->data
                wfSuppressWarnings();
@@ -85,6 +89,9 @@
                return $this->getSkin()->getLanguage()->pipeList( $s );
        }
 
+       /**
+        * @return string
+        */
        function otherLanguages() {
                if ( $this->config->get( 'HideInterlanguageLinks' ) ) {
                        return "";
@@ -113,6 +120,7 @@
 
        /**
         * @param string $name
+        * @return string
         */
        protected function renderAfterPortlet( $name ) {
                $content = '';
@@ -123,6 +131,9 @@
                return $html;
        }
 
+       /**
+        * @return string
+        */
        function pageTitleLinks() {
                $s = [];
                $footlinks = $this->getFooterLinks();
@@ -160,6 +171,9 @@
                );
        }
 
+       /**
+        * @return string
+        */
        function bottomLinks() {
                $toolbox = $this->getToolbox();
                $content_nav = $this->data['content_navigation'];
@@ -246,6 +260,9 @@
                return implode( array_filter( $lines ), "<br />\n" ) . "<br 
/>\n";
        }
 
+       /**
+        * @return string
+        */
        function talkLink() {
                $title = $this->getSkin()->getTitle();
 
@@ -303,6 +320,7 @@
         * @param array $navlink Navigational link generated by SkinTemplate
         * @param mixed $idPrefix Prefix to add to id of this navlink. If 
false, id
         *   is removed entirely. Default is 'cb-'.
+        * @return array
         */
        function processNavlinkForDocument( $navlink, $idPrefix = 'cb-' ) {
                if ( $navlink['id'] ) {
@@ -625,7 +643,7 @@
        }
 
        /**
-        * @param string $label
+        * @param string $which
         * @return string
         */
        function searchForm( $which ) {
diff --git a/phpcs.xml b/phpcs.xml
index 5371223..7827c78 100644
--- a/phpcs.xml
+++ b/phpcs.xml
@@ -1,13 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <ruleset>
        <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingParamTag"/>
                <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingParamComment"/>
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingReturn"/>
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
                <exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
                <exclude name="MediaWiki.Files.OneClassPerFile.MultipleFound" />
-               <exclude 
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic"/>
                <exclude 
name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment"/>
        </rule>
        <file>.</file>

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

Gerrit-MessageType: merged
Gerrit-Change-Id: I68c54d34311e83536e7520ad932cddf0449054c4
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/skins/CologneBlue
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

Reply via email to