Umherirrender has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/384240 )
Change subject: Improve some parameter docs ...................................................................... Improve some parameter docs Change-Id: Ifc6ce723f851f1d274ec09e1c86946361b7b8cc8 --- M ShortUrl.hooks.php M ShortUrl.utils.php M SpecialShortUrl.php M phpcs.xml 4 files changed, 11 insertions(+), 14 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/ShortUrl refs/changes/40/384240/1 diff --git a/ShortUrl.hooks.php b/ShortUrl.hooks.php index 44db8fe..3374d55 100644 --- a/ShortUrl.hooks.php +++ b/ShortUrl.hooks.php @@ -11,7 +11,7 @@ class ShortUrlHooks { /** - * @param $router PathRouter + * @param PathRouter $router * @return bool * * Adds ShortURL rules to the URL router. @@ -27,7 +27,7 @@ } /** - * @param $tpl SkinTemplate + * @param SkinTemplate &$tpl * @return bool */ public static function addToolboxLink( &$tpl ) { @@ -66,8 +66,8 @@ } /** - * @param $out OutputPage - * @param $text string the HTML text to be added + * @param OutputPage &$out + * @param string &$text the HTML text to be added * @return bool */ public static function onOutputPageBeforeHTML( &$out, &$text ) { @@ -80,7 +80,7 @@ } /** - * @param $du DatabaseUpdater + * @param DatabaseUpdater $du * @return bool */ public static function setupSchema( DatabaseUpdater $du ) { diff --git a/ShortUrl.utils.php b/ShortUrl.utils.php index c391e5d..fc47b80 100644 --- a/ShortUrl.utils.php +++ b/ShortUrl.utils.php @@ -19,7 +19,7 @@ class ShortUrlUtils { /** - * @param $title Title + * @param Title $title * @return string|bool false if read-only mode */ public static function encodeTitle( Title $title ) { @@ -82,7 +82,7 @@ } /** - * @param $urlFragment String + * @param string $urlFragment * @return Title */ public static function decodeURL( $urlFragment ) { @@ -110,8 +110,8 @@ } /** - * @param $title Title - * @return Boolean true if a short URL needs to be displayed + * @param Title $title + * @return bool true if a short URL needs to be displayed */ public static function needsShortUrl( $title ) { return $title->exists() && !$title->isMainPage(); diff --git a/SpecialShortUrl.php b/SpecialShortUrl.php index d9e226f..4488753 100644 --- a/SpecialShortUrl.php +++ b/SpecialShortUrl.php @@ -30,7 +30,7 @@ /** * Main execution function * - * @param $par Mixed: Parameters passed to the page + * @param string|null $par Parameters passed to the page */ public function execute( $par ) { $out = $this->getOutput(); diff --git a/phpcs.xml b/phpcs.xml index 05f2894..b2c2c48 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -1,8 +1,7 @@ <?xml version="1.0"?> <ruleset> <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"> - <exclude name="MediaWiki.Commenting.FunctionComment.MissingParamName" /> - <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.Commenting.FunctionComment.MissingDocumentationProtected" /> @@ -11,6 +10,4 @@ <file>.</file> <arg name="extensions" value="php,php5,inc" /> <arg name="encoding" value="UTF-8" /> - <exclude-pattern>vendor</exclude-pattern> - <exclude-pattern>node_modules</exclude-pattern> </ruleset> -- To view, visit https://gerrit.wikimedia.org/r/384240 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ifc6ce723f851f1d274ec09e1c86946361b7b8cc8 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/ShortUrl 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