Improve some parameter docs

Change-Id: I1d6bece3380b6d2144feee512de736c12d62d09e
This commit is contained in:
Umherirrender 2018-01-11 17:33:57 +01:00
parent 2c0c4ead96
commit 8396437cb8
2 changed files with 7 additions and 10 deletions

View file

@ -1,8 +1,6 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<ruleset> <ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki"> <rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamName" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" /> <exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" /> <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationProtected" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" /> <exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
@ -11,6 +9,5 @@
</rule> </rule>
<file>.</file> <file>.</file>
<arg name="extensions" value="php,php5,inc" /> <arg name="extensions" value="php,php5,inc" />
<arg name="encoding" value="utf8" /> <arg name="encoding" value="UTF-8" />
<exclude-pattern>vendor</exclude-pattern>
</ruleset> </ruleset>

View file

@ -21,11 +21,11 @@ class ContributionScores extends IncludableSpecialPage {
/** /**
* Function generates Contribution Scores tables in HTML format (not wikiText) * Function generates Contribution Scores tables in HTML format (not wikiText)
* *
* @param $days int Days in the past to run report for * @param int $days Days in the past to run report for
* @param $limit int Maximum number of users to return (default 50) * @param int $limit Maximum number of users to return (default 50)
* @param $title Title (default null) * @param string|null $title The title of the table
* @param $options array of options (default none; nosort/notools) * @param array $options array of options (default none; nosort/notools)
* @return Html Table representing the requested Contribution Scores. * @return string Html Table representing the requested Contribution Scores.
*/ */
function genContributionScoreTable( $days, $limit, $title = null, $options = 'none' ) { function genContributionScoreTable( $days, $limit, $title = null, $options = 'none' ) {
global $wgContribScoreIgnoreBots, $wgContribScoreIgnoreBlockedUsers, $wgContribScoresUseRealName; global $wgContribScoreIgnoreBots, $wgContribScoreIgnoreBlockedUsers, $wgContribScoresUseRealName;
@ -188,7 +188,7 @@ class ContributionScores extends IncludableSpecialPage {
/** /**
* Called when being included on a normal wiki page. * Called when being included on a normal wiki page.
* Cache is disabled so it can depend on the user language. * Cache is disabled so it can depend on the user language.
* @param $par * @param string|null $par A subpage give to the special page
*/ */
function showInclude( $par ) { function showInclude( $par ) {
$days = null; $days = null;