Improve some parameter docs

Change-Id: Ie4326ecb517e5c7381b946b45bc108f8889fd4b2
This commit is contained in:
Umherirrender 2017-10-07 11:24:02 +02:00
parent 6c69ffaf75
commit 01376c8e05
4 changed files with 9 additions and 13 deletions

View file

@ -427,6 +427,7 @@ class ApiQueryExtracts extends ApiQueryBase {
/**
* @see ApiBase::getExamplesMessages()
* @return array
*/
protected function getExamplesMessages() {
return [

View file

@ -12,7 +12,7 @@ class Hooks {
/**
* ApiOpenSearchSuggest hook handler
* @param array $results
* @param array &$results
* @return bool
*/
public static function onApiOpenSearchSuggest( &$results ) {

View file

@ -2,16 +2,11 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
<exclude name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
<exclude name="MediaWiki.WhiteSpace.SpaceBeforeSingleLineComment.NewLineComment" />
</rule>
<file>.</file>
<arg name="extensions" value="php,php5,inc" />
<arg name="encoding" value="utf8" />
<exclude-pattern>vendor</exclude-pattern>
<exclude-pattern>node_modules</exclude-pattern>
<arg name="encoding" value="UTF-8" />
</ruleset>

View file

@ -72,9 +72,9 @@ class ExtractFormatterTest extends MediaWikiTestCase {
/**
* @dataProvider provideGetFirstSentences
* @param $text
* @param $sentences
* @param $expected
* @param string $text
* @param string $sentences
* @param string $expected
*/
public function testGetFirstSentences( $text, $sentences, $expected ) {
$this->assertEquals( $expected, ExtractFormatter::getFirstSentences( $text, $sentences ) );
@ -167,9 +167,9 @@ class ExtractFormatterTest extends MediaWikiTestCase {
/**
* @dataProvider provideGetFirstChars
* @param $text
* @param $chars
* @param $expected
* @param string $text
* @param string $chars
* @param string $expected
*/
public function testGetFirstChars( $text, $chars, $expected ) {
$this->assertEquals( $expected, ExtractFormatter::getFirstChars( $text, $chars ) );