Umherirrender has uploaded a new change for review. https://gerrit.wikimedia.org/r/148991
Change subject: Cleanup some docs (languages, maintenance, tests) ...................................................................... Cleanup some docs (languages, maintenance, tests) - Swap "$variable type" to "type $variable" - Added missing types - Fixed spacing inside docs - Makes beginning of @param/@return/@var/@throws in capital - Changed some types to match the more common spelling Change-Id: Ia041964250d8b7c0349d79dc9b131c5b8696e795 --- M languages/Language.php M languages/LanguageConverter.php M languages/classes/LanguageZh.php M maintenance/findHooks.php M maintenance/language/languages.inc M maintenance/parse.php M maintenance/sql.php M maintenance/sqlite.inc M tests/parser/parserTest.inc M tests/phpunit/MediaWikiTestCase.php M tests/phpunit/includes/HtmlFormatterTest.php M tests/phpunit/includes/ImagePage404Test.php M tests/phpunit/includes/ImagePageTest.php M tests/phpunit/includes/MimeMagicTest.php M tests/phpunit/includes/OutputPageTest.php M tests/phpunit/includes/StatusTest.php M tests/phpunit/includes/api/ApiMainTest.php M tests/phpunit/includes/api/ApiTestCase.php M tests/phpunit/includes/api/ApiTestCaseUpload.php M tests/phpunit/includes/api/RandomImageGenerator.php M tests/phpunit/includes/api/query/ApiQueryContinueTestBase.php M tests/phpunit/includes/api/query/ApiQueryTestBase.php M tests/phpunit/includes/cache/MessageCacheTest.php M tests/phpunit/includes/content/ContentHandlerTest.php M tests/phpunit/includes/db/ORMRowTest.php M tests/phpunit/includes/diff/DifferenceEngineTest.php M tests/phpunit/includes/filerepo/file/FileTest.php M tests/phpunit/includes/media/JpegMetadataExtractorTest.php M tests/phpunit/includes/media/MediaWikiMediaTestCase.php M tests/phpunit/includes/media/PNGTest.php M tests/phpunit/includes/media/XCFTest.php M tests/phpunit/includes/parser/MagicVariableTest.php M tests/phpunit/includes/parser/MediaWikiParserTest.php M tests/phpunit/includes/specials/SpecialMIMESearchTest.php M tests/phpunit/includes/specials/SpecialMyLanguageTest.php M tests/phpunit/languages/LanguageTest.php M tests/phpunit/maintenance/backupPrefetchTest.php M tests/phpunit/maintenance/backupTextPassTest.php M tests/phpunit/maintenance/fetchTextTest.php 39 files changed, 88 insertions(+), 88 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core refs/changes/91/148991/1 diff --git a/languages/Language.php b/languages/Language.php index 8b41b4e..4ac6fdc 100644 --- a/languages/Language.php +++ b/languages/Language.php @@ -2351,7 +2351,7 @@ * Get the formatted date and time for the given timestamp and formatted for * the given user. * - * @param mixed $ts the time format which needs to be turned into a + * @param mixed $ts The time format which needs to be turned into a * date('YmdHis') format with wfTimestamp(TS_MW,$ts) * @param User $user User object used to get preferences for timezone and format * @param array $options Array, can contain the following keys: @@ -3786,8 +3786,8 @@ * * @since 1.23 * - * @param int $count non-localized number - * @param array $forms different plural forms + * @param int $count Non-localized number + * @param array $forms Different plural forms * * @return array|string */ @@ -3992,7 +3992,7 @@ * Get the list of variants supported by this language * see sample implementation in LanguageZh.php * - * @return array an array of language codes + * @return array An array of language codes */ public function getVariants() { return $this->mConverter->getVariants(); @@ -4029,7 +4029,7 @@ * @param Title $nt The title object of the link * @param bool $ignoreOtherCond To disable other conditions when * we need to transclude a template or update a category's link - * @return null the input parameters may be modified upon return + * @return void The input parameters may be modified upon return */ public function findVariantLink( &$link, &$nt, $ignoreOtherCond = false ) { $this->mConverter->findVariantLink( $link, $nt, $ignoreOtherCond ); @@ -4284,7 +4284,7 @@ * * @since 1.22 * @param string $code Language code - * @return array array( fallbacks, site fallbacks ) + * @return array Array( fallbacks, site fallbacks ) */ public static function getFallbacksIncludingSiteLanguage( $code ) { global $wgLanguageCode; @@ -4339,7 +4339,7 @@ * * @since 1.19 * @param string $code Language code - * @return array of message keys (strings) + * @return array Array of message keys (strings) */ public static function getMessageKeysFor( $code ) { return self::getLocalisationCache()->getSubItemList( $code, 'messages' ); diff --git a/languages/LanguageConverter.php b/languages/LanguageConverter.php index b3a4c1a..1faa9a6 100644 --- a/languages/LanguageConverter.php +++ b/languages/LanguageConverter.php @@ -54,7 +54,7 @@ public $mManualLevel; /** - * @var string memcached key name + * @var string Memcached key name */ public $mCacheKey; diff --git a/languages/classes/LanguageZh.php b/languages/classes/LanguageZh.php index dfdc6b1..58dc1b6 100644 --- a/languages/classes/LanguageZh.php +++ b/languages/classes/LanguageZh.php @@ -166,7 +166,7 @@ * auto convert to zh-hans and normalize special characters. * * @param string $string - * @param string $autoVariant default to 'zh-hans' + * @param string $autoVariant Default to 'zh-hans' * @return string */ function normalizeForSearch( $string, $autoVariant = 'zh-hans' ) { diff --git a/maintenance/findHooks.php b/maintenance/findHooks.php index 9929cf9..db9b3060 100644 --- a/maintenance/findHooks.php +++ b/maintenance/findHooks.php @@ -136,7 +136,7 @@ /** * Get the hook documentation, either locally or from MediaWiki.org - * @return array of documented hooks + * @return array Array of documented hooks */ private function getHooksFromDoc( $doc ) { if ( $this->hasOption( 'online' ) ) { @@ -148,7 +148,7 @@ /** * Get hooks from a local file (for example docs/hooks.txt) - * @param string $doc filename to look in + * @param string $doc Filename to look in * @return array Array of documented hooks */ private function getHooksFromLocalDoc( $doc ) { @@ -161,7 +161,7 @@ /** * Get hooks from www.mediawiki.org using the API - * @return array of documented hooks + * @return array Array of documented hooks */ private function getHooksFromOnlineDoc() { // All hooks @@ -199,7 +199,7 @@ /** * Get hooks from a PHP file * @param string $file Full filename to the PHP file. - * @return array of hooks found. + * @return array Array of hooks found */ private function getHooksFromFile( $file ) { $content = file_get_contents( $file ); diff --git a/maintenance/language/languages.inc b/maintenance/language/languages.inc index 9c9b7ff..fb496cb 100644 --- a/maintenance/language/languages.inc +++ b/maintenance/language/languages.inc @@ -55,7 +55,7 @@ /** @var array Magic words */ protected $mMagicWords; - /** @var array Special page aliases */ + /** @var array Special page aliases */ protected $mSpecialPageAliases; /** diff --git a/maintenance/parse.php b/maintenance/parse.php index 9af57da..638d7c5 100644 --- a/maintenance/parse.php +++ b/maintenance/parse.php @@ -113,7 +113,7 @@ * Default title is 'CLIParser', it can be overriden with the option * --title <Your:Title> * - * @return Title object + * @return Title */ protected function getTitle() { $title = $this->getOption( 'title' ) diff --git a/maintenance/sql.php b/maintenance/sql.php index c947a4c..389b270 100644 --- a/maintenance/sql.php +++ b/maintenance/sql.php @@ -136,7 +136,7 @@ /** * Print the results, callback for $db->sourceStream() * @param ResultWrapper $res The results object - * @param DatabaseBase $db object + * @param DatabaseBase $db */ public function sqlPrintResult( $res, $db ) { if ( !$res ) { diff --git a/maintenance/sqlite.inc b/maintenance/sqlite.inc index 9729a72..680eed0 100644 --- a/maintenance/sqlite.inc +++ b/maintenance/sqlite.inc @@ -42,7 +42,7 @@ * Will throw exceptions on SQL errors * @param array|string $files * @throws MWException - * @return string|bool true if no error or error string in case of errors + * @return string|bool True if no error or error string in case of errors */ public static function checkSqlSyntax( $files ) { if ( !Sqlite::isPresent() ) { diff --git a/tests/parser/parserTest.inc b/tests/parser/parserTest.inc index e76b9df..7a9375d 100644 --- a/tests/parser/parserTest.inc +++ b/tests/parser/parserTest.inc @@ -1370,7 +1370,7 @@ /** * Print a skipped message. * - * @return boolean + * @return bool */ protected function showSkipped() { if ( $this->showProgress ) { diff --git a/tests/phpunit/MediaWikiTestCase.php b/tests/phpunit/MediaWikiTestCase.php index 02330a4..feb3ec4 100644 --- a/tests/phpunit/MediaWikiTestCase.php +++ b/tests/phpunit/MediaWikiTestCase.php @@ -331,7 +331,7 @@ * * @param array|string $globalKeys Key to the global variable, or an array of keys. * - * @throws Exception when trying to stash an unset global + * @throws Exception When trying to stash an unset global * @since 1.23 */ protected function stashMwGlobals( $globalKeys ) { @@ -370,7 +370,7 @@ * @param string $name The name of the global, as in wgFooBar * @param array $values The array containing the entries to set in that global * - * @throws MWException if the designated global is not an array. + * @throws MWException If the designated global is not an array. * * @since 1.21 */ @@ -516,7 +516,7 @@ * @param DatabaseBase $db The database connection * @param string $prefix The prefix to use for the new table set (aka schema). * - * @throws MWException if the database table prefix is already $prefix + * @throws MWException If the database table prefix is already $prefix */ public static function setupTestDB( DatabaseBase $db, $prefix ) { global $wgDBprefix; diff --git a/tests/phpunit/includes/HtmlFormatterTest.php b/tests/phpunit/includes/HtmlFormatterTest.php index ae5c9c4..9dbfa45 100644 --- a/tests/phpunit/includes/HtmlFormatterTest.php +++ b/tests/phpunit/includes/HtmlFormatterTest.php @@ -8,7 +8,7 @@ * @dataProvider getHtmlData * * @param string $input - * @param $expectedText + * @param string $expectedText * @param array $expectedRemoved * @param callable|bool $callback */ diff --git a/tests/phpunit/includes/ImagePage404Test.php b/tests/phpunit/includes/ImagePage404Test.php index 3660456..197a2b3 100644 --- a/tests/phpunit/includes/ImagePage404Test.php +++ b/tests/phpunit/includes/ImagePage404Test.php @@ -29,8 +29,8 @@ /** * @dataProvider providerGetThumbSizes - * @param $filename String - * @param $expectedNumberThumbs integer How many thumbnails to show + * @param string $filename + * @param int $expectedNumberThumbs How many thumbnails to show */ function testGetThumbSizes( $filename, $expectedNumberThumbs ) { $iPage = $this->getImagePage( $filename ); diff --git a/tests/phpunit/includes/ImagePageTest.php b/tests/phpunit/includes/ImagePageTest.php index d5ecb95..0272c54 100644 --- a/tests/phpunit/includes/ImagePageTest.php +++ b/tests/phpunit/includes/ImagePageTest.php @@ -22,8 +22,8 @@ /** * @dataProvider providerGetDisplayWidthHeight - * @param $dimensions Array [maxWidth, maxHeight, width, height] - * @param $expected Array [width, height] The width and height we expect to display at + * @param array $dimensions Array [maxWidth, maxHeight, width, height] + * @param array $expected Array [width, height] The width and height we expect to display at */ function testGetDisplayWidthHeight( $dim, $expected ) { $iPage = $this->getImagePage( 'animated.gif' ); @@ -66,8 +66,8 @@ /** * @dataProvider providerGetThumbSizes - * @param $filename String - * @param $expectedNumberThumbs integer How many thumbnails to show + * @param string $filename + * @param int $expectedNumberThumbs How many thumbnails to show */ function testGetThumbSizes( $filename, $expectedNumberThumbs ) { $iPage = $this->getImagePage( $filename ); diff --git a/tests/phpunit/includes/MimeMagicTest.php b/tests/phpunit/includes/MimeMagicTest.php index a164ff9..f6ccc8e 100644 --- a/tests/phpunit/includes/MimeMagicTest.php +++ b/tests/phpunit/includes/MimeMagicTest.php @@ -11,9 +11,9 @@ /** * @dataProvider providerImproveTypeFromExtension - * @param $ext String File extension (no leading dot) - * @param $oldMime String Initially detected mime - * @param $expectedMime String Mime type after taking extension into account + * @param string $ext File extension (no leading dot) + * @param string $oldMime Initially detected mime + * @param string $expectedMime Mime type after taking extension into account */ function testImproveTypeFromExtension( $ext, $oldMime, $expectedMime ) { $actualMime = $this->mimeMagic->improveTypeFromExtension( $oldMime, $ext ); diff --git a/tests/phpunit/includes/OutputPageTest.php b/tests/phpunit/includes/OutputPageTest.php index f68b3b1..cd2e1d8 100644 --- a/tests/phpunit/includes/OutputPageTest.php +++ b/tests/phpunit/includes/OutputPageTest.php @@ -25,7 +25,7 @@ * options['expectedReturn'] - expected return value * options['message'] - PHPUnit message for assertion * - * @param array $args key-value array of arguments as shown above + * @param array $args Key-value array of arguments as shown above */ protected function assertTransformCssMediaCase( $args ) { $queryData = array(); diff --git a/tests/phpunit/includes/StatusTest.php b/tests/phpunit/includes/StatusTest.php index b2e4459..feb6559 100644 --- a/tests/phpunit/includes/StatusTest.php +++ b/tests/phpunit/includes/StatusTest.php @@ -203,7 +203,7 @@ } /** - * @param array $messageDetails eg. array( 'KEY' => array(/PARAMS/) ) + * @param array $messageDetails Eg. array( 'KEY' => array(/PARAMS/) ) * @return Message[] */ protected function getMockMessages( $messageDetails ) { @@ -320,7 +320,7 @@ } /** - * @return array of arrays with values; + * @return array Array of arrays with values; * 0 => status object * 1 => expected string (with no context) */ @@ -391,7 +391,7 @@ } /** - * @return array of arrays with values; + * @return array Array of arrays with values; * 0 => status object * 1 => expected Message parameters (with no context) * 2 => expected Message key diff --git a/tests/phpunit/includes/api/ApiMainTest.php b/tests/phpunit/includes/api/ApiMainTest.php index 8c5f540..780cf9e 100644 --- a/tests/phpunit/includes/api/ApiMainTest.php +++ b/tests/phpunit/includes/api/ApiMainTest.php @@ -55,7 +55,7 @@ * @dataProvider provideAssert * @param User $user * @param string $assert - * @param string|bool $error false if no error expected + * @param string|bool $error False if no error expected */ public function testAssert( $user, $assert, $error ) { try { diff --git a/tests/phpunit/includes/api/ApiTestCase.php b/tests/phpunit/includes/api/ApiTestCase.php index 0976b1a..388949d 100644 --- a/tests/phpunit/includes/api/ApiTestCase.php +++ b/tests/phpunit/includes/api/ApiTestCase.php @@ -43,10 +43,10 @@ /** * Edits or creates a page/revision - * @param string $pageName page title - * @param string $text content of the page - * @param string $summary optional summary string for the revision - * @param int $defaultNs optional namespace id + * @param string $pageName Page title + * @param string $text Content of the page + * @param string $summary Optional summary string for the revision + * @param int $defaultNs Optional namespace id * @return array Array as returned by WikiPage::doEditContent() */ protected function editPage( $pageName, $text, $summary = '', $defaultNs = NS_MAIN ) { @@ -119,10 +119,10 @@ * requesting a "real" edit token. * * @param array $params Key-value API params - * @param array|null $session session array + * @param array|null $session Session array * @param User|null $user A User object for the context * @return mixed Result of the API call - * @throws Exception in case wsToken is not set in the session + * @throws Exception In case wsToken is not set in the session */ protected function doApiRequestWithToken( array $params, array $session = null, User $user = null diff --git a/tests/phpunit/includes/api/ApiTestCaseUpload.php b/tests/phpunit/includes/api/ApiTestCaseUpload.php index 40407dc..7c7a36a 100644 --- a/tests/phpunit/includes/api/ApiTestCaseUpload.php +++ b/tests/phpunit/includes/api/ApiTestCaseUpload.php @@ -30,7 +30,7 @@ /** * Helper function -- remove files and associated articles by Title * - * @param Title $title title to be removed + * @param Title $title Title to be removed * * @return bool */ @@ -65,7 +65,7 @@ /** * Helper function -- remove files and associated articles with a particular filename * - * @param string $fileName filename to be removed + * @param string $fileName Filename to be removed * * @return bool */ @@ -77,7 +77,7 @@ * Helper function -- given a file on the filesystem, find matching * content in the db (and associated articles) and remove them. * - * @param string $filePath path to file on the filesystem + * @param string $filePath Path to file on the filesystem * * @return bool */ @@ -96,10 +96,10 @@ * Fake an upload by dumping the file into temp space, and adding info to $_FILES. * (This is what PHP would normally do). * - * @param string $fieldName name this would have in the upload form - * @param string $fileName name to title this - * @param string $type mime type - * @param string $filePath path where to find file contents + * @param string $fieldName Name this would have in the upload form + * @param string $fileName Name to title this + * @param string $type Mime type + * @param string $filePath Path where to find file contents * * @throws Exception * @return bool diff --git a/tests/phpunit/includes/api/RandomImageGenerator.php b/tests/phpunit/includes/api/RandomImageGenerator.php index e3eea4c..6374cfa 100644 --- a/tests/phpunit/includes/api/RandomImageGenerator.php +++ b/tests/phpunit/includes/api/RandomImageGenerator.php @@ -328,7 +328,7 @@ * This is used when simulating a rotated image capture with Exif orientation * @param array $spec Returned by getImageSpec * @param array $matrix 2x2 transformation matrix - * @return array transformed Spec + * @return array Transformed Spec */ private static function rotateImageSpec( &$spec, $matrix ) { $tSpec = array(); @@ -365,8 +365,8 @@ /** * Given a matrix and a pair of images, return new position * @param array $matrix 2x2 rotation matrix - * @param int $x x-coordinate number - * @param int $y y-coordinate number + * @param int $x The x-coordinate number + * @param int $y The y-coordinate number * @return array Transformed with properties x, y */ private static function matrixMultiply2x2( $matrix, $x, $y ) { @@ -432,7 +432,7 @@ * array( array( 'foo', 'bar' ), array( 'quux', 'baz' ) ); * * @param int $number Number of pairs - * @return array two-element arrays + * @return array Two-element arrays */ private function getRandomWordPairs( $number ) { $lines = $this->getRandomLines( $number * 2 ); @@ -451,7 +451,7 @@ * * Will throw exception if the file could not be read or if it had fewer lines than requested. * - * @param int $number_desired number of lines desired + * @param int $number_desired Number of lines desired * * @throws Exception * @return array Array of exactly n elements, drawn randomly from lines the file diff --git a/tests/phpunit/includes/api/query/ApiQueryContinueTestBase.php b/tests/phpunit/includes/api/query/ApiQueryContinueTestBase.php index d8765ee..bea11ef 100644 --- a/tests/phpunit/includes/api/query/ApiQueryContinueTestBase.php +++ b/tests/phpunit/includes/api/query/ApiQueryContinueTestBase.php @@ -37,7 +37,7 @@ * @param array $params Api parameters * @param int $expectedCount Max number of iterations * @param string $id Unit test id - * @param bool $useContinue true to use smart continue + * @param bool $useContinue True to use smart continue * @return mixed Merged results data array */ protected function checkC( $expected, $params, $expectedCount, $id, $continue = true ) { @@ -50,7 +50,7 @@ * @param array $params Api parameters * @param int $expectedCount Max number of iterations * @param string $id Unit test id - * @param bool $useContinue true to use smart continue + * @param bool $useContinue True to use smart continue * @return mixed Merged results data array * @throws Exception */ diff --git a/tests/phpunit/includes/api/query/ApiQueryTestBase.php b/tests/phpunit/includes/api/query/ApiQueryTestBase.php index 1b9c1ce..f920ce9 100644 --- a/tests/phpunit/includes/api/query/ApiQueryTestBase.php +++ b/tests/phpunit/includes/api/query/ApiQueryTestBase.php @@ -34,7 +34,7 @@ /** * Merges all requests parameter + expected values into one - * @param ... list of arrays, each of which contains exactly two + * @param array $v,... List of arrays, each of which contains exactly two * @return array */ protected function merge( /*...*/ ) { diff --git a/tests/phpunit/includes/cache/MessageCacheTest.php b/tests/phpunit/includes/cache/MessageCacheTest.php index 803acf7..442e9f9 100644 --- a/tests/phpunit/includes/cache/MessageCacheTest.php +++ b/tests/phpunit/includes/cache/MessageCacheTest.php @@ -59,7 +59,7 @@ * Helper function for addDBData -- adds a simple page to the database * * @param string $title Title of page to be created - * @param string $lang Language and content of the created page + * @param string $lang Language and content of the created page * @param string|null $content Content of the created page, or null for a generic string * @param bool $createSubPage Set to false if a root page should be created */ diff --git a/tests/phpunit/includes/content/ContentHandlerTest.php b/tests/phpunit/includes/content/ContentHandlerTest.php index 2add9f2..5fe2e0e 100644 --- a/tests/phpunit/includes/content/ContentHandlerTest.php +++ b/tests/phpunit/includes/content/ContentHandlerTest.php @@ -431,7 +431,7 @@ * Returns native represenation of the data. Interpretation depends on the data model used, * as given by getDataModel(). * - * @return mixed the native representation of the content. Could be a string, a nested array + * @return mixed The native representation of the content. Could be a string, a nested array * structure, an object, a binary blob... anything, really. */ public function getNativeData() { @@ -459,7 +459,7 @@ * return $this. That is, $copy === $original may be true, but only for imutable content * objects. * - * @return Content. A copy of this object. + * @return Content A copy of this object */ public function copy() { return $this; @@ -469,7 +469,7 @@ * Returns true if this content is countable as a "real" wiki page, provided * that it's also in a countable location (e.g. a current revision in the main namespace). * - * @param bool $hasLinks if it is known whether this content contains links, + * @param bool $hasLinks If it is known whether this content contains links, * provide this information here, to avoid redundant parsing to find out. * @return bool */ @@ -481,7 +481,7 @@ * @param Title $title * @param int $revId Unused. * @param null|ParserOptions $options - * @param bool $generateHtml whether to generate Html (default: true). If false, the result + * @param bool $generateHtml Whether to generate Html (default: true). If false, the result * of calling getText() on the ParserOutput object returned by this method is undefined. * * @return ParserOutput diff --git a/tests/phpunit/includes/db/ORMRowTest.php b/tests/phpunit/includes/db/ORMRowTest.php index 4ff6165..447bf21 100644 --- a/tests/phpunit/includes/db/ORMRowTest.php +++ b/tests/phpunit/includes/db/ORMRowTest.php @@ -115,7 +115,7 @@ /** * @since 1.20 - * @return array of IORMRow + * @return array Array of IORMRow */ public function instanceProvider() { $instances = array(); diff --git a/tests/phpunit/includes/diff/DifferenceEngineTest.php b/tests/phpunit/includes/diff/DifferenceEngineTest.php index e1a69e3..5474b96 100644 --- a/tests/phpunit/includes/diff/DifferenceEngineTest.php +++ b/tests/phpunit/includes/diff/DifferenceEngineTest.php @@ -39,7 +39,7 @@ } /** - * @return int[] revision ids + * @return int[] Revision ids */ protected function doEdits() { $title = $this->getTitle(); diff --git a/tests/phpunit/includes/filerepo/file/FileTest.php b/tests/phpunit/includes/filerepo/file/FileTest.php index ffa9876..8e8b8a9 100644 --- a/tests/phpunit/includes/filerepo/file/FileTest.php +++ b/tests/phpunit/includes/filerepo/file/FileTest.php @@ -3,8 +3,8 @@ class FileTest extends MediaWikiMediaTestCase { /** - * @param $filename String - * @param $expected boolean + * @param string $filename + * @param bool $expected * @dataProvider providerCanAnimate */ function testCanAnimateThumbIfAppropriate( $filename, $expected ) { diff --git a/tests/phpunit/includes/media/JpegMetadataExtractorTest.php b/tests/phpunit/includes/media/JpegMetadataExtractorTest.php index 80e03cc..7c977d5 100644 --- a/tests/phpunit/includes/media/JpegMetadataExtractorTest.php +++ b/tests/phpunit/includes/media/JpegMetadataExtractorTest.php @@ -23,7 +23,7 @@ * We also use this test to test padding bytes don't * screw stuff up * - * @param string $file filename + * @param string $file Filename * * @dataProvider provideUtf8Comment */ diff --git a/tests/phpunit/includes/media/MediaWikiMediaTestCase.php b/tests/phpunit/includes/media/MediaWikiMediaTestCase.php index 1b8ecf2..8f28158 100644 --- a/tests/phpunit/includes/media/MediaWikiMediaTestCase.php +++ b/tests/phpunit/includes/media/MediaWikiMediaTestCase.php @@ -33,7 +33,7 @@ } /** - * @return Array Argument for FSRepo constructor + * @return array Argument for FSRepo constructor */ protected function getRepoOptions() { return array( @@ -47,7 +47,7 @@ * The result of this method will set the file path to use, * as well as the protected member $filePath * - * @return String path where files are + * @return string Path where files are */ protected function getFilePath() { return __DIR__ . '/../../data/media/'; @@ -59,7 +59,7 @@ * * Override this method if your test case creates thumbnails * - * @return boolean + * @return bool */ protected function createsThumbnails() { return false; @@ -69,8 +69,8 @@ * Utility function: Get a new file object for a file on disk but not actually in db. * * File must be in the path returned by getFilePath() - * @param $name String File name - * @param $type String MIME type [optional] + * @param string $name File name + * @param string $type MIME type [optional] * @return UnregisteredLocalFile */ protected function dataFile( $name, $type = null ) { diff --git a/tests/phpunit/includes/media/PNGTest.php b/tests/phpunit/includes/media/PNGTest.php index 9a4826c..092be89 100644 --- a/tests/phpunit/includes/media/PNGTest.php +++ b/tests/phpunit/includes/media/PNGTest.php @@ -22,7 +22,7 @@ } /** - * @param string $filename basename of the file to check + * @param string $filename Basename of the file to check * @param bool $expected Expected result. * @dataProvider provideIsAnimated * @covers PNGHandler::isAnimatedImage diff --git a/tests/phpunit/includes/media/XCFTest.php b/tests/phpunit/includes/media/XCFTest.php index 7fc3275..9b6391c 100644 --- a/tests/phpunit/includes/media/XCFTest.php +++ b/tests/phpunit/includes/media/XCFTest.php @@ -16,8 +16,8 @@ /** * @param string $filename - * @param int $expectedWidth width - * @param int $expectedHeigh height + * @param int $expectedWidth Width + * @param int $expectedHeigh Height * @dataProvider provideGetImageSize * @covers XCFHandler::getImageSize */ diff --git a/tests/phpunit/includes/parser/MagicVariableTest.php b/tests/phpunit/includes/parser/MagicVariableTest.php index d36697e..1722611 100644 --- a/tests/phpunit/includes/parser/MagicVariableTest.php +++ b/tests/phpunit/includes/parser/MagicVariableTest.php @@ -171,7 +171,7 @@ * Main assertion helper for magic variables padding * @param string $magic Magic variable name * @param mixed $value Month or day - * @param string $format sprintf format for $value + * @param string $format Sprintf format for $value */ private function assertMagicPadding( $magic, $value, $format ) { # Initialize parser timestamp as year 2010 at 12h34 56s. diff --git a/tests/phpunit/includes/parser/MediaWikiParserTest.php b/tests/phpunit/includes/parser/MediaWikiParserTest.php index a506c86..a450972 100644 --- a/tests/phpunit/includes/parser/MediaWikiParserTest.php +++ b/tests/phpunit/includes/parser/MediaWikiParserTest.php @@ -45,7 +45,7 @@ * MediaWikiParserTest::suite( MediaWikiParserTest::WITH_ALL ); * @endcode * - * @param int $flags bitwise flag to filter out the $wgParserTestFiles that + * @param int $flags Bitwise flag to filter out the $wgParserTestFiles that * will be included. Default: MediaWikiParserTest::CORE_ONLY * * @return PHPUnit_Framework_TestSuite diff --git a/tests/phpunit/includes/specials/SpecialMIMESearchTest.php b/tests/phpunit/includes/specials/SpecialMIMESearchTest.php index e7bb35c..580e616 100644 --- a/tests/phpunit/includes/specials/SpecialMIMESearchTest.php +++ b/tests/phpunit/includes/specials/SpecialMIMESearchTest.php @@ -16,9 +16,9 @@ /** * @dataProvider providerMimeFiltering - * @param $par String subpage for special page - * @param $major String Major mime type we expect to look for - * @param $minor String Minor mime type we expect to look for + * @param string $par Subpage for special page + * @param string $major Major mime type we expect to look for + * @param string $minor Minor mime type we expect to look for */ function testMimeFiltering( $par, $major, $minor ) { $this->page->run( $par ); diff --git a/tests/phpunit/includes/specials/SpecialMyLanguageTest.php b/tests/phpunit/includes/specials/SpecialMyLanguageTest.php index c09d68c..fd09043 100644 --- a/tests/phpunit/includes/specials/SpecialMyLanguageTest.php +++ b/tests/phpunit/includes/specials/SpecialMyLanguageTest.php @@ -26,10 +26,10 @@ /** * @covers SpecialMyLanguage::findTitle * @dataProvider provideFindTitle - * @param $expected - * @param $subpage - * @param $langCode - * @param $userLang + * @param string $expected + * @param string $subpage + * @param string $langCode + * @param string $userLang */ public function testFindTitle( $expected, $subpage, $langCode, $userLang ) { $this->setMwGlobals( 'wgLanguageCode', $langCode ); diff --git a/tests/phpunit/languages/LanguageTest.php b/tests/phpunit/languages/LanguageTest.php index ec51441..cff2e8f 100644 --- a/tests/phpunit/languages/LanguageTest.php +++ b/tests/phpunit/languages/LanguageTest.php @@ -276,7 +276,7 @@ } /** - * @return array format is ($len, $ellipsis, $input, $expected) + * @return array Format is ($len, $ellipsis, $input, $expected) */ public static function provideHTMLTruncateData() { return array( diff --git a/tests/phpunit/maintenance/backupPrefetchTest.php b/tests/phpunit/maintenance/backupPrefetchTest.php index 744cf61..5e0fe89 100644 --- a/tests/phpunit/maintenance/backupPrefetchTest.php +++ b/tests/phpunit/maintenance/backupPrefetchTest.php @@ -11,7 +11,7 @@ class BaseDumpTest extends MediaWikiTestCase { /** - * @var BaseDump the BaseDump instance used within a test. + * @var BaseDump The BaseDump instance used within a test. * * If set, this BaseDump gets automatically closed in tearDown. */ diff --git a/tests/phpunit/maintenance/backupTextPassTest.php b/tests/phpunit/maintenance/backupTextPassTest.php index 016b7e0..a37a97c 100644 --- a/tests/phpunit/maintenance/backupTextPassTest.php +++ b/tests/phpunit/maintenance/backupTextPassTest.php @@ -434,7 +434,7 @@ * revision id increase further and further, while the text * id of the first iteration is reused. The pages and revision * of iteration > 1 have no corresponding representation in the database. - * @return string absolute filename of the stub + * @return string Absolute filename of the stub */ private function setUpStub( $fname = null, $iterations = 1 ) { if ( $fname === null ) { diff --git a/tests/phpunit/maintenance/fetchTextTest.php b/tests/phpunit/maintenance/fetchTextTest.php index 43f2096..1ad4656 100644 --- a/tests/phpunit/maintenance/fetchTextTest.php +++ b/tests/phpunit/maintenance/fetchTextTest.php @@ -91,7 +91,7 @@ private $exceptionFromAddDBData; /** - * @var FetchText the (mocked) FetchText that is to test + * @var FetchText The (mocked) FetchText that is to test */ private $fetchText; -- To view, visit https://gerrit.wikimedia.org/r/148991 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ia041964250d8b7c0349d79dc9b131c5b8696e795 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/core 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