From: Thiemo Mättig Date: Thu, 28 Dec 2017 15:06:10 +0000 (+0100) Subject: Remove @param comments that literally repeat what the code says X-Git-Tag: 1.31.0-rc.0~927^2 X-Git-Url: https://git.cyclocoop.org/%7B%24admin_url%7Dmembres/cotisations/rappels.php?a=commitdiff_plain;h=ef470ebf7f7716c2c1a20960d642a1d898231f6a;p=lhc%2Fweb%2Fwiklou.git Remove @param comments that literally repeat what the code says These comments do not add anything. I argue they are worse than having no comments, because I have to read them first to understand they actually don't explain anything. Removing them makes room for actual improvements in the future (if needed). Change-Id: Iee70aad681b3385e9af282d5581c10addbb91ac4 --- diff --git a/includes/EditPage.php b/includes/EditPage.php index bcaab3a3d7..6d64388dc1 100644 --- a/includes/EditPage.php +++ b/includes/EditPage.php @@ -780,7 +780,7 @@ class EditPage { /** * Display a read-only View Source page - * @param Content $content content object + * @param Content $content * @param string $errorMessage additional wikitext error message to display */ protected function displayViewSourcePage( Content $content, $errorMessage = '' ) { diff --git a/includes/FeedUtils.php b/includes/FeedUtils.php index 6c343ab39f..6108ca1d46 100644 --- a/includes/FeedUtils.php +++ b/includes/FeedUtils.php @@ -97,7 +97,7 @@ class FeedUtils { /** * Really format a diff for the newsfeed * - * @param Title $title Title object + * @param Title $title * @param int $oldid Old revision's id * @param int $newid New revision's id * @param int $timestamp New revision's timestamp diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index 1a33b76357..7c5656d0f5 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -1011,7 +1011,7 @@ function wfMakeUrlIndexes( $url ) { /** * Check whether a given URL has a domain that occurs in a given set of domains - * @param string $url URL + * @param string $url * @param array $domains Array of domains (strings) * @return bool True if the host part of $url ends in one of the strings in $domains */ diff --git a/includes/Linker.php b/includes/Linker.php index 84e3103c65..bda40afb9a 100644 --- a/includes/Linker.php +++ b/includes/Linker.php @@ -1023,7 +1023,7 @@ class Linker { /** * @since 1.16.3 - * @param int $userId Userid + * @param int $userId * @param string $userText User name in database. * @return string HTML fragment with block link */ @@ -1037,7 +1037,7 @@ class Linker { } /** - * @param int $userId Userid + * @param int $userId * @param string $userText User name in database. * @return string HTML fragment with e-mail user link */ diff --git a/includes/OutputPage.php b/includes/OutputPage.php index 1c2c29dca3..05cf3daba4 100644 --- a/includes/OutputPage.php +++ b/includes/OutputPage.php @@ -323,7 +323,7 @@ class OutputPage extends ContextSource { /** * Redirect to $url rather than displaying the normal page * - * @param string $url URL + * @param string $url * @param string $responsecode HTTP status code */ public function redirect( $url, $responsecode = '302' ) { diff --git a/includes/Preferences.php b/includes/Preferences.php index 33a975d104..06d5298c9f 100644 --- a/includes/Preferences.php +++ b/includes/Preferences.php @@ -1164,7 +1164,7 @@ class Preferences { } /** - * @param User $user The User object + * @param User $user * @param IContextSource $context * @return array Text/links to display as key; $skinkey as value */ diff --git a/includes/WebRequest.php b/includes/WebRequest.php index 3d5e372c5a..cd62737c56 100644 --- a/includes/WebRequest.php +++ b/includes/WebRequest.php @@ -407,7 +407,7 @@ class WebRequest { * * @since 1.28 * @param string $name - * @param string|null $default Optional default + * @param string|null $default * @return string|null */ public function getRawVal( $name, $default = null ) { diff --git a/includes/Xml.php b/includes/Xml.php index 0091513125..2f11e26ab9 100644 --- a/includes/Xml.php +++ b/includes/Xml.php @@ -160,8 +160,9 @@ class Xml { } /** - * @param int $year - * @param int $month + * @param int|string $year Use '' or 0 to start with no year preselected. + * @param int|string $month A month in the 1..12 range. Use '', 0 or -1 to start with no month + * preselected. * @return string Formatted HTML */ public static function dateMenu( $year, $month ) { diff --git a/includes/actions/HistoryAction.php b/includes/actions/HistoryAction.php index 85e8db63b0..f7ac21b76e 100644 --- a/includes/actions/HistoryAction.php +++ b/includes/actions/HistoryAction.php @@ -611,7 +611,7 @@ class HistoryPager extends ReverseChronologicalPager { * Creates a submit button * * @param string $message Text of the submit button, will be escaped - * @param array $attributes Attributes + * @param array $attributes * @return string HTML output for the submit button */ function submitButton( $message, $attributes = [] ) { diff --git a/includes/actions/InfoAction.php b/includes/actions/InfoAction.php index 62f7ddfc1a..cb01a9d268 100644 --- a/includes/actions/InfoAction.php +++ b/includes/actions/InfoAction.php @@ -186,7 +186,7 @@ class InfoAction extends FormlessAction { * Adds a table to the content that will be added to the output. * * @param string $content The content that will be added to the output - * @param string $table The table + * @param string $table * @return string The content with the table added */ protected function addTable( $content, $table ) { diff --git a/includes/api/ApiBase.php b/includes/api/ApiBase.php index 83d2ae9bea..d4e6391b57 100644 --- a/includes/api/ApiBase.php +++ b/includes/api/ApiBase.php @@ -1029,7 +1029,7 @@ abstract class ApiBase extends ContextSource { * @param string $paramName Parameter name * @param array|mixed $paramSettings Default value or an array of settings * using PARAM_* constants. - * @param bool $parseLimit Parse limit? + * @param bool $parseLimit Whether to parse and validate 'limit' parameters * @return mixed Parameter value */ protected function getParameterFromSettings( $paramName, $paramSettings, $parseLimit ) { diff --git a/includes/api/ApiPageSet.php b/includes/api/ApiPageSet.php index cfac761c91..774ea1ad5d 100644 --- a/includes/api/ApiPageSet.php +++ b/includes/api/ApiPageSet.php @@ -753,7 +753,7 @@ class ApiPageSet extends ApiBase { * $this->getPageTableFields(). * * @param IDatabase $db - * @param ResultWrapper $queryResult Query result object + * @param ResultWrapper $queryResult */ public function populateFromQueryResult( $db, $queryResult ) { $this->initFromQueryResult( $queryResult ); diff --git a/includes/auth/LegacyHookPreAuthenticationProvider.php b/includes/auth/LegacyHookPreAuthenticationProvider.php index cab6e32d5b..97bbde7532 100644 --- a/includes/auth/LegacyHookPreAuthenticationProvider.php +++ b/includes/auth/LegacyHookPreAuthenticationProvider.php @@ -115,9 +115,9 @@ class LegacyHookPreAuthenticationProvider extends AbstractPreAuthenticationProvi * Construct an appropriate failure response * @param User $user * @param User|null $creator - * @param int $constant LoginForm constant - * @param string|null $msg Message - * @param string $hook Hook + * @param int $constant One of the LoginForm::… constants + * @param string|null $msg Optional message key, will be derived from $constant otherwise + * @param string $hook Name of the hook for error logging and exception messages * @return StatusValue */ protected function makeFailResponse( $user, $creator, $constant, $msg, $hook ) { diff --git a/includes/cache/CacheDependency.php b/includes/cache/CacheDependency.php index a59ba97d0a..2c9d214d09 100644 --- a/includes/cache/CacheDependency.php +++ b/includes/cache/CacheDependency.php @@ -99,7 +99,7 @@ class DependencyWrapper { * it will be generated with the callback function (if present), and the newly * calculated value will be stored to the cache in a wrapper. * - * @param BagOStuff $cache A cache object + * @param BagOStuff $cache * @param string $key The cache key * @param int $expiry The expiry timestamp or interval in seconds * @param bool|callable $callback The callback for generating the value, or false diff --git a/includes/cache/GenderCache.php b/includes/cache/GenderCache.php index a34d23586a..099a986f7b 100644 --- a/includes/cache/GenderCache.php +++ b/includes/cache/GenderCache.php @@ -56,7 +56,7 @@ class GenderCache { /** * Returns the gender for given username. - * @param string|User $username Username + * @param string|User $username * @param string $caller The calling method * @return string */ diff --git a/includes/cache/MessageCache.php b/includes/cache/MessageCache.php index d6e9b748ab..48721866aa 100644 --- a/includes/cache/MessageCache.php +++ b/includes/cache/MessageCache.php @@ -156,22 +156,22 @@ class MessageCache { } /** - * @param WANObjectCache $wanCache WAN cache instance - * @param BagOStuff $clusterCache Cluster cache instance - * @param BagOStuff $srvCache Server cache instance + * @param WANObjectCache $wanCache + * @param BagOStuff $clusterCache + * @param BagOStuff $serverCache * @param bool $useDB Whether to look for message overrides (e.g. MediaWiki: pages) * @param int $expiry Lifetime for cache. @see $mExpiry. */ public function __construct( WANObjectCache $wanCache, BagOStuff $clusterCache, - BagOStuff $srvCache, + BagOStuff $serverCache, $useDB, $expiry ) { $this->wanCache = $wanCache; $this->clusterCache = $clusterCache; - $this->srvCache = $srvCache; + $this->srvCache = $serverCache; $this->mDisable = !$useDB; $this->mExpiry = $expiry; diff --git a/includes/changes/ChangesListBooleanFilterGroup.php b/includes/changes/ChangesListBooleanFilterGroup.php index 7bab97bac2..4401378b28 100644 --- a/includes/changes/ChangesListBooleanFilterGroup.php +++ b/includes/changes/ChangesListBooleanFilterGroup.php @@ -54,7 +54,7 @@ class ChangesListBooleanFilterGroup extends ChangesListFilterGroup { /** * Registers a filter in this group * - * @param ChangesListBooleanFilter $filter ChangesListBooleanFilter + * @param ChangesListBooleanFilter $filter */ public function registerFilter( ChangesListBooleanFilter $filter ) { $this->filters[$filter->getName()] = $filter; diff --git a/includes/changes/ChangesListFilter.php b/includes/changes/ChangesListFilter.php index 1c86d44174..d1ecd84193 100644 --- a/includes/changes/ChangesListFilter.php +++ b/includes/changes/ChangesListFilter.php @@ -184,8 +184,7 @@ abstract class ChangesListFilter { * (not filtered out), even for the hide-based filters. So e.g. conflicting with * 'hideanons' means there is a conflict if only anonymous users are *shown*. * - * @param ChangesListFilterGroup|ChangesListFilter $other Other - * ChangesListFilterGroup or ChangesListFilter + * @param ChangesListFilterGroup|ChangesListFilter $other * @param string $globalKey i18n key for top-level conflict message * @param string $forwardKey i18n key for conflict message in this * direction (when in UI context of $this object) @@ -216,8 +215,7 @@ abstract class ChangesListFilter { * * Internal use ONLY. * - * @param ChangesListFilterGroup|ChangesListFilter $other Other - * ChangesListFilterGroup or ChangesListFilter + * @param ChangesListFilterGroup|ChangesListFilter $other * @param string $globalDescription i18n key for top-level conflict message * @param string $contextDescription i18n key for conflict message in this * direction (when in UI context of $this object) diff --git a/includes/changes/ChangesListFilterGroup.php b/includes/changes/ChangesListFilterGroup.php index 48c6e840a0..f569dca18c 100644 --- a/includes/changes/ChangesListFilterGroup.php +++ b/includes/changes/ChangesListFilterGroup.php @@ -223,8 +223,7 @@ abstract class ChangesListFilterGroup { * (not filtered out), even for the hide-based filters. So e.g. conflicting with * 'hideanons' means there is a conflict if only anonymous users are *shown*. * - * @param ChangesListFilterGroup|ChangesListFilter $other Other - * ChangesListFilterGroup or ChangesListFilter + * @param ChangesListFilterGroup|ChangesListFilter $other * @param string $globalKey i18n key for top-level conflict message * @param string $forwardKey i18n key for conflict message in this * direction (when in UI context of $this object) @@ -255,8 +254,7 @@ abstract class ChangesListFilterGroup { * * Internal use ONLY. * - * @param ChangesListFilterGroup|ChangesListFilter $other Other - * ChangesListFilterGroup or ChangesListFilter + * @param ChangesListFilterGroup|ChangesListFilter $other * @param string $globalDescription i18n key for top-level conflict message * @param string $contextDescription i18n key for conflict message in this * direction (when in UI context of $this object) diff --git a/includes/changes/ChangesListStringOptionsFilterGroup.php b/includes/changes/ChangesListStringOptionsFilterGroup.php index 775fd76d1e..1497a448af 100644 --- a/includes/changes/ChangesListStringOptionsFilterGroup.php +++ b/includes/changes/ChangesListStringOptionsFilterGroup.php @@ -155,7 +155,7 @@ class ChangesListStringOptionsFilterGroup extends ChangesListFilterGroup { /** * Registers a filter in this group * - * @param ChangesListStringOptionsFilter $filter ChangesListStringOptionsFilter + * @param ChangesListStringOptionsFilter $filter */ public function registerFilter( ChangesListStringOptionsFilter $filter ) { $this->filters[$filter->getName()] = $filter; diff --git a/includes/changetags/ChangeTags.php b/includes/changetags/ChangeTags.php index db1f599087..95848ea085 100644 --- a/includes/changetags/ChangeTags.php +++ b/includes/changetags/ChangeTags.php @@ -135,7 +135,7 @@ class ChangeTags { * exists, provided it is not disabled. If the message is disabled, * we consider the tag hidden, and return false. * - * @param string $tag Tag + * @param string $tag * @param IContextSource $context * @return string|bool Tag description or false if tag is to be hidden. * @since 1.25 Returns false if tag is to be hidden. @@ -162,7 +162,7 @@ class ChangeTags { * or if message is disabled, returns false. Otherwise, returns the message object * for the long description. * - * @param string $tag Tag + * @param string $tag * @param IContextSource $context * @return Message|bool Message object of the tag long description or false if * there is no description. diff --git a/includes/content/AbstractContent.php b/includes/content/AbstractContent.php index c12d28d9bc..65dc3bb19b 100644 --- a/includes/content/AbstractContent.php +++ b/includes/content/AbstractContent.php @@ -492,7 +492,7 @@ abstract class AbstractContent implements Content { * * @param Title $title Context title for parsing * @param int|null $revId Revision ID (for {{REVISIONID}}) - * @param ParserOptions|null $options Parser options + * @param ParserOptions|null $options * @param bool $generateHtml Whether or not to generate HTML * * @return ParserOutput Containing information derived from this content. @@ -536,7 +536,7 @@ abstract class AbstractContent implements Content { * * @param Title $title Context title for parsing * @param int|null $revId Revision ID (for {{REVISIONID}}) - * @param ParserOptions $options Parser options + * @param ParserOptions $options * @param bool $generateHtml Whether or not to generate HTML * @param ParserOutput &$output The output object to fill (reference). * diff --git a/includes/content/JsonContent.php b/includes/content/JsonContent.php index 2b94f3f71e..7d8f67ce9d 100644 --- a/includes/content/JsonContent.php +++ b/includes/content/JsonContent.php @@ -75,8 +75,8 @@ class JsonContent extends TextContent { /** * Beautifies JSON prior to save. * - * @param Title $title Title - * @param User $user User + * @param Title $title + * @param User $user * @param ParserOptions $popts * @return JsonContent */ diff --git a/includes/content/TextContent.php b/includes/content/TextContent.php index e5a9f90d16..71f65b37e1 100644 --- a/includes/content/TextContent.php +++ b/includes/content/TextContent.php @@ -236,7 +236,7 @@ class TextContent extends AbstractContent { * * @param Title $title Context title for parsing * @param int $revId Revision ID (for {{REVISIONID}}) - * @param ParserOptions $options Parser options + * @param ParserOptions $options * @param bool $generateHtml Whether or not to generate HTML * @param ParserOutput &$output The output object to fill (reference). */ diff --git a/includes/exception/LocalizedException.php b/includes/exception/LocalizedException.php index d2cb5d17ec..f5f8c84e86 100644 --- a/includes/exception/LocalizedException.php +++ b/includes/exception/LocalizedException.php @@ -45,7 +45,7 @@ class LocalizedException extends Exception implements ILocalizedException { /** * @param string|array|MessageSpecifier $messageSpec See Message::newFromSpecifier - * @param int $code Exception code + * @param int $code * @param Exception|Throwable $previous The previous exception used for the exception chaining. */ public function __construct( $messageSpec, $code = 0, $previous = null ) { diff --git a/includes/gallery/ImageGalleryBase.php b/includes/gallery/ImageGalleryBase.php index eeb8a8ff84..80fd22ebaa 100644 --- a/includes/gallery/ImageGalleryBase.php +++ b/includes/gallery/ImageGalleryBase.php @@ -177,7 +177,7 @@ abstract class ImageGalleryBase extends ContextSource { /** * Set the caption (as plain text) * - * @param string $caption Caption + * @param string $caption */ function setCaption( $caption ) { $this->mCaption = htmlspecialchars( $caption ); @@ -186,7 +186,7 @@ abstract class ImageGalleryBase extends ContextSource { /** * Set the caption (as HTML) * - * @param string $caption Caption + * @param string $caption */ public function setCaptionHtml( $caption ) { $this->mCaption = $caption; diff --git a/includes/installer/PostgresInstaller.php b/includes/installer/PostgresInstaller.php index cb1b47e1e3..21d83d2397 100644 --- a/includes/installer/PostgresInstaller.php +++ b/includes/installer/PostgresInstaller.php @@ -152,7 +152,7 @@ class PostgresInstaller extends DatabaseInstaller { /** * Open a PG connection with given parameters * @param string $user User name - * @param string $password Password + * @param string $password * @param string $dbName Database name * @param string $schema Database schema * @return Status diff --git a/includes/libs/IEUrlExtension.php b/includes/libs/IEUrlExtension.php index 2d1c58b66a..0d969fb270 100644 --- a/includes/libs/IEUrlExtension.php +++ b/includes/libs/IEUrlExtension.php @@ -186,7 +186,7 @@ class IEUrlExtension { * - if we find a possible extension followed by a dot or another illegal * character, we ignore it and continue searching * - * @param string $url URL + * @param string $url * @return mixed Detected extension (string), or false if none found */ public static function findIE6Extension( $url ) { diff --git a/includes/libs/StatusValue.php b/includes/libs/StatusValue.php index f9dcc1b52e..6f348c2b96 100644 --- a/includes/libs/StatusValue.php +++ b/includes/libs/StatusValue.php @@ -214,7 +214,7 @@ class StatusValue { /** * Merge another status object into this one * - * @param StatusValue $other Other StatusValue object + * @param StatusValue $other * @param bool $overwriteValue Whether to override the "value" member */ public function merge( $other, $overwriteValue = false ) { diff --git a/includes/libs/mime/XmlTypeCheck.php b/includes/libs/mime/XmlTypeCheck.php index 97611086b0..648fb67f9f 100644 --- a/includes/libs/mime/XmlTypeCheck.php +++ b/includes/libs/mime/XmlTypeCheck.php @@ -294,7 +294,7 @@ class XmlTypeCheck { /** * @param string $name element or attribute name, maybe with a full or short prefix - * @param string $namespaceURI the namespaceURI + * @param string $namespaceURI * @return string the name prefixed with namespaceURI */ private function expandNS( $name, $namespaceURI ) { diff --git a/includes/libs/objectcache/MemcachedClient.php b/includes/libs/objectcache/MemcachedClient.php index 5cb49a9972..91863b2d84 100644 --- a/includes/libs/objectcache/MemcachedClient.php +++ b/includes/libs/objectcache/MemcachedClient.php @@ -363,7 +363,7 @@ class MemcachedClient { /** * Changes the TTL on a key from the server to $time * - * @param string $key Key + * @param string $key * @param int $time TTL in seconds * * @return bool True on success, false on failure diff --git a/includes/libs/rdbms/TransactionProfiler.php b/includes/libs/rdbms/TransactionProfiler.php index 57a12a4463..a828cd3f1c 100644 --- a/includes/libs/rdbms/TransactionProfiler.php +++ b/includes/libs/rdbms/TransactionProfiler.php @@ -82,7 +82,7 @@ class TransactionProfiler implements LoggerAwareInterface { } /** - * @param bool $value New value + * @param bool $value * @return bool Old value * @since 1.28 */ diff --git a/includes/logging/LogEventsList.php b/includes/logging/LogEventsList.php index 00d3bd3315..93a81cff8e 100644 --- a/includes/logging/LogEventsList.php +++ b/includes/logging/LogEventsList.php @@ -98,8 +98,9 @@ class LogEventsList extends ContextSource { * @param string $user * @param string $page * @param string $pattern - * @param int $year Year - * @param int $month Month + * @param int|string $year Use 0 to start with no year preselected. + * @param int|string $month A month in the 1..12 range. Use 0 to start with no month + * preselected. * @param array $filter * @param string $tagFilter Tag to select by default * @param string $action @@ -426,7 +427,7 @@ class LogEventsList extends ContextSource { } /** - * @param stdClass $row Row + * @param stdClass $row * @return string */ private function getShowHideLinks( $row ) { @@ -496,7 +497,7 @@ class LogEventsList extends ContextSource { } /** - * @param stdClass $row Row + * @param stdClass $row * @param string|array $type * @param string|array $action * @param string $right @@ -521,7 +522,7 @@ class LogEventsList extends ContextSource { * Determine if the current user is allowed to view a particular * field of this log row, if it's marked as deleted. * - * @param stdClass $row Row + * @param stdClass $row * @param int $field * @param User $user User to check, or null to use $wgUser * @return bool @@ -558,7 +559,7 @@ class LogEventsList extends ContextSource { } /** - * @param stdClass $row Row + * @param stdClass $row * @param int $field One of DELETED_* bitfield constants * @return bool */ diff --git a/includes/logging/LogPage.php b/includes/logging/LogPage.php index e421209278..77d9aa21ba 100644 --- a/includes/logging/LogPage.php +++ b/includes/logging/LogPage.php @@ -319,7 +319,7 @@ class LogPage { * * @param string $action One of '', 'block', 'protect', 'rights', 'delete', * 'upload', 'move', 'move_redir' - * @param Title $target Title object + * @param Title $target * @param string $comment Description associated * @param array $params Parameters passed later to wfMessage function * @param null|int|User $doer The user doing the action. null for $wgUser diff --git a/includes/media/BitmapMetadataHandler.php b/includes/media/BitmapMetadataHandler.php index 2ed5db36f7..9e0fc3db36 100644 --- a/includes/media/BitmapMetadataHandler.php +++ b/includes/media/BitmapMetadataHandler.php @@ -292,7 +292,7 @@ class BitmapMetadataHandler { * Read the first 2 bytes of a tiff file to figure out * Little Endian or Big Endian. Needed for exif stuff. * - * @param string $filename The filename + * @param string $filename * @return string 'BE' or 'LE' or false */ static function getTiffByteOrder( $filename ) { diff --git a/includes/media/IPTC.php b/includes/media/IPTC.php index 343adc2088..894043a4e5 100644 --- a/includes/media/IPTC.php +++ b/includes/media/IPTC.php @@ -353,20 +353,20 @@ class IPTC { * @todo Potentially this should also capture the timezone offset. * @param array $date The date tag * @param array $time The time tag - * @param string $c The charset + * @param string $charset * @return string Date in EXIF format. */ - private static function timeHelper( $date, $time, $c ) { + private static function timeHelper( $date, $time, $charset ) { if ( count( $date ) === 1 ) { // the standard says this should always be 1 // just double checking. - list( $date ) = self::convIPTC( $date, $c ); + list( $date ) = self::convIPTC( $date, $charset ); } else { return null; } if ( count( $time ) === 1 ) { - list( $time ) = self::convIPTC( $time, $c ); + list( $time ) = self::convIPTC( $time, $charset ); $dateOnly = false; } else { $time = '000000+0000'; // placeholder @@ -420,7 +420,7 @@ class IPTC { /** * Helper function to convert charset for iptc values. * @param string|array $data The iptc string - * @param string $charset The charset + * @param string $charset * * @return string|array */ @@ -439,7 +439,7 @@ class IPTC { /** * Helper function of a helper function to convert charset for iptc values. * @param string|array $data The IPTC string - * @param string $charset The charset + * @param string $charset * * @return string */ diff --git a/includes/media/MediaHandler.php b/includes/media/MediaHandler.php index 8551a120a5..5dca24bcba 100644 --- a/includes/media/MediaHandler.php +++ b/includes/media/MediaHandler.php @@ -255,7 +255,7 @@ abstract class MediaHandler { * Get a MediaTransformOutput object representing the transformed output. Does not * actually do the transform. * - * @param File $image The image object + * @param File $image * @param string $dstPath Filesystem destination path * @param string $dstUrl Destination URL to use in output HTML * @param array $params Arbitrary set of parameters validated by $this->validateParam() @@ -269,7 +269,7 @@ abstract class MediaHandler { * Get a MediaTransformOutput object representing the transformed output. Does the * transform unless $flags contains self::TRANSFORM_LATER. * - * @param File $image The image object + * @param File $image * @param string $dstPath Filesystem destination path * @param string $dstUrl Destination URL to use in output HTML * @param array $params Arbitrary set of parameters validated by $this->validateParam() @@ -497,7 +497,7 @@ abstract class MediaHandler { * * This is used by the media handlers that use the FormatMetadata class * - * @param array $metadataArray Metadata array + * @param array $metadataArray * @param bool|IContextSource $context Context to use (optional) * @return array Array for use displaying metadata. */ diff --git a/includes/media/WebP.php b/includes/media/WebP.php index e23989dfa8..e0af6def45 100644 --- a/includes/media/WebP.php +++ b/includes/media/WebP.php @@ -154,7 +154,7 @@ class WebPHandler extends BitmapHandler { /** * Decodes a lossy chunk header - * @param string $header Header string + * @param string $header First few bytes of the header, expected to be at least 18 bytes long * @return bool|array See WebPHandler::decodeHeader */ protected static function decodeLossyChunkHeader( $header ) { @@ -180,7 +180,7 @@ class WebPHandler extends BitmapHandler { /** * Decodes a lossless chunk header - * @param string $header Header string + * @param string $header First few bytes of the header, expected to be at least 13 bytes long * @return bool|array See WebPHandler::decodeHeader */ public static function decodeLosslessChunkHeader( $header ) { @@ -205,7 +205,7 @@ class WebPHandler extends BitmapHandler { /** * Decodes an extended chunk header - * @param string $header Header string + * @param string $header First few bytes of the header, expected to be at least 18 bytes long * @return bool|array See WebPHandler::decodeHeader */ public static function decodeExtendedChunkHeader( $header ) { diff --git a/includes/media/XCF.php b/includes/media/XCF.php index 3587eba656..1b6c4c87ed 100644 --- a/includes/media/XCF.php +++ b/includes/media/XCF.php @@ -151,7 +151,7 @@ class XCFHandler extends BitmapHandler { * * @param File|FSFile $file The image object, or false if there isn't one. * Warning, FSFile::getPropsFromPath might pass an (object)array() instead (!) - * @param string $filename The filename + * @param string $filename * @return string */ public function getMetadata( $file, $filename ) { diff --git a/includes/parser/Parser.php b/includes/parser/Parser.php index 078de3c601..84798a0712 100644 --- a/includes/parser/Parser.php +++ b/includes/parser/Parser.php @@ -4683,7 +4683,7 @@ class Parser { * Wrapper for preprocess() * * @param string $text The text to preprocess - * @param ParserOptions $options Options + * @param ParserOptions $options * @param Title|null $title Title object or null to use $wgTitle * @return string */ @@ -5976,7 +5976,7 @@ class Parser { /** * Remove any strip markers found in the given text. * - * @param string $text Input string + * @param string $text * @return string */ public function killMarkers( $text ) { diff --git a/includes/parser/StripState.php b/includes/parser/StripState.php index 4ed176ce28..298aad3313 100644 --- a/includes/parser/StripState.php +++ b/includes/parser/StripState.php @@ -233,7 +233,7 @@ class StripState { /** * Remove any strip markers found in the given text. * - * @param string $text Input string + * @param string $text * @return string */ public function killMarkers( $text ) { diff --git a/includes/resourceloader/ResourceLoaderModule.php b/includes/resourceloader/ResourceLoaderModule.php index b3c1cd14b7..aaa276774b 100644 --- a/includes/resourceloader/ResourceLoaderModule.php +++ b/includes/resourceloader/ResourceLoaderModule.php @@ -110,7 +110,7 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface { * Set this module's name. This is called by ResourceLoader::register() * when registering the module. Other code should not call this. * - * @param string $name Name + * @param string $name */ public function setName( $name ) { $this->name = $name; @@ -932,7 +932,7 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface { * Get this module's last modification timestamp for a given context. * * @deprecated since 1.26 Use getDefinitionSummary() instead - * @param ResourceLoaderContext $context Context object + * @param ResourceLoaderContext $context * @return int|null UNIX timestamp */ public function getModifiedTime( ResourceLoaderContext $context ) { diff --git a/includes/revisiondelete/RevDelItem.php b/includes/revisiondelete/RevDelItem.php index bf97bd4100..4762085289 100644 --- a/includes/revisiondelete/RevDelItem.php +++ b/includes/revisiondelete/RevDelItem.php @@ -57,7 +57,7 @@ abstract class RevDelItem extends RevisionItemBase { /** * Get the return information about the revision for the API * @since 1.23 - * @param ApiResult $result API result object + * @param ApiResult $result * @return array Data for the API result */ abstract public function getApiData( ApiResult $result ); diff --git a/includes/search/SearchExactMatchRescorer.php b/includes/search/SearchExactMatchRescorer.php index 0e99ba91ff..c99db6e4e8 100644 --- a/includes/search/SearchExactMatchRescorer.php +++ b/includes/search/SearchExactMatchRescorer.php @@ -34,7 +34,7 @@ class SearchExactMatchRescorer { * may sort based on other algorithms that may cause the exact title match * to not be in the results or be lower down the list. * @param string $search the query - * @param int[] $namespaces the namespaces + * @param int[] $namespaces * @param string[] $srchres results * @param int $limit the max number of results to return * @return string[] munged results @@ -96,7 +96,7 @@ class SearchExactMatchRescorer { } /** - * @param string[] $titles as strings + * @param string[] $titles * @return array redirect target prefixedText to index of title in titles * that is a redirect to it. */ diff --git a/includes/session/SessionBackend.php b/includes/session/SessionBackend.php index d37b73b550..44806eddef 100644 --- a/includes/session/SessionBackend.php +++ b/includes/session/SessionBackend.php @@ -97,7 +97,7 @@ final class SessionBackend { private $shutdown = false; /** - * @param SessionId $id Session ID object + * @param SessionId $id * @param SessionInfo $info Session info to populate from * @param CachedBagOStuff $store Backend data store * @param LoggerInterface $logger diff --git a/includes/specialpage/ChangesListSpecialPage.php b/includes/specialpage/ChangesListSpecialPage.php index 303184de17..282d764239 100644 --- a/includes/specialpage/ChangesListSpecialPage.php +++ b/includes/specialpage/ChangesListSpecialPage.php @@ -1812,7 +1812,7 @@ abstract class ChangesListSpecialPage extends SpecialPage { * * @since 1.31 * @param Config $config - * @param User $user User object + * @param User $user * @return bool */ public static function checkStructuredFilterUiEnabled( Config $config, User $user ) { diff --git a/includes/specials/SpecialRecentchanges.php b/includes/specials/SpecialRecentchanges.php index 32204f8587..24617541ab 100644 --- a/includes/specials/SpecialRecentchanges.php +++ b/includes/specials/SpecialRecentchanges.php @@ -825,7 +825,7 @@ class SpecialRecentChanges extends ChangesListSpecialPage { /** * Makes change an option link which carries all the other options * - * @param string $title Title + * @param string $title * @param array $override Options to override * @param array $options Current options * @param bool $active Whether to show the link in bold diff --git a/includes/specials/SpecialUploadStash.php b/includes/specials/SpecialUploadStash.php index 8cdfb87f53..c8b1578fe5 100644 --- a/includes/specials/SpecialUploadStash.php +++ b/includes/specials/SpecialUploadStash.php @@ -315,7 +315,7 @@ class SpecialUploadStash extends UnlistedSpecialPage { /** * Output HTTP response of raw content * Side effect: writes HTTP response to STDOUT. - * @param string $content Content + * @param string $content * @param string $contentType MIME type * @throws SpecialUploadStashTooLargeException * @return bool diff --git a/includes/specials/pagers/UsersPager.php b/includes/specials/pagers/UsersPager.php index 45d9a7fc84..4efe92d743 100644 --- a/includes/specials/pagers/UsersPager.php +++ b/includes/specials/pagers/UsersPager.php @@ -407,7 +407,7 @@ class UsersPager extends AlphabeticPager { * Format a link to a group description page * * @param string|UserGroupMembership $group Group name or UserGroupMembership object - * @param string $username Username + * @param string $username * @return string */ protected function buildGroupLink( $group, $username ) { diff --git a/includes/user/User.php b/includes/user/User.php index 0d8ef89290..8ac9a61019 100644 --- a/includes/user/User.php +++ b/includes/user/User.php @@ -4583,7 +4583,7 @@ class User implements IDBAccessObject, UserIdentity { * (T8957 with Gmail and Internet Explorer). * * @param string $page Special page - * @param string $token Token + * @param string $token * @return string Formatted URL */ protected function getTokenUrl( $page, $token ) { diff --git a/maintenance/generateSitemap.php b/maintenance/generateSitemap.php index bed84a811b..f568ddbfe3 100644 --- a/maintenance/generateSitemap.php +++ b/maintenance/generateSitemap.php @@ -440,8 +440,8 @@ class GenerateSitemap extends Maintenance { /** * Get a sitemap filename * - * @param int $namespace The namespace - * @param int $count The count + * @param int $namespace + * @param int $count * @return string */ function sitemapFilename( $namespace, $count ) { diff --git a/maintenance/importImages.php b/maintenance/importImages.php index d3aa280a34..a72ec67321 100644 --- a/maintenance/importImages.php +++ b/maintenance/importImages.php @@ -440,7 +440,7 @@ class ImportImages extends Maintenance { /** * Split a filename into filename and extension * - * @param string $filename Filename + * @param string $filename * @return array */ private function splitFilename( $filename ) { diff --git a/maintenance/sql.php b/maintenance/sql.php index 8e276e7750..a67b28e55d 100644 --- a/maintenance/sql.php +++ b/maintenance/sql.php @@ -167,7 +167,7 @@ class MwSql extends Maintenance { /** * Print the results, callback for $db->sourceStream() - * @param ResultWrapper|bool $res The results object + * @param ResultWrapper|bool $res * @param IDatabase $db */ public function sqlPrintResult( $res, $db ) { diff --git a/tests/phpunit/includes/auth/LegacyHookPreAuthenticationProviderTest.php b/tests/phpunit/includes/auth/LegacyHookPreAuthenticationProviderTest.php index a4b980f04b..0fdb08c0e5 100644 --- a/tests/phpunit/includes/auth/LegacyHookPreAuthenticationProviderTest.php +++ b/tests/phpunit/includes/auth/LegacyHookPreAuthenticationProviderTest.php @@ -282,7 +282,7 @@ class LegacyHookPreAuthenticationProviderTest extends \MediaWikiTestCase { * @dataProvider provideTestForAccountCreation * @param string $msg * @param Status|null $status - * @param StatusValue $result Result + * @param StatusValue $result */ public function testTestForAccountCreation( $msg, $status, $result ) { $this->hook( 'AbortNewAccount', $this->once() ) diff --git a/tests/phpunit/includes/collation/CollationTest.php b/tests/phpunit/includes/collation/CollationTest.php index 25911a79c1..b92e651e2b 100644 --- a/tests/phpunit/includes/collation/CollationTest.php +++ b/tests/phpunit/includes/collation/CollationTest.php @@ -21,7 +21,7 @@ class CollationTest extends MediaWikiLangTestCase { * code makes this assumption. * * @param string $lang Language code for collator - * @param string $base Base string + * @param string $base * @param string $extended String containing base as a prefix. * * @dataProvider prefixDataProvider diff --git a/tests/phpunit/includes/session/TestBagOStuff.php b/tests/phpunit/includes/session/TestBagOStuff.php index fd02a2e9c6..bac2088d9a 100644 --- a/tests/phpunit/includes/session/TestBagOStuff.php +++ b/tests/phpunit/includes/session/TestBagOStuff.php @@ -14,7 +14,7 @@ class TestBagOStuff extends \CachedBagOStuff { /** * @param string $id Session ID * @param array $data Session data - * @param int $expiry Expiry + * @param int $expiry * @param User $user User for metadata */ public function setSessionData( $id, array $data, $expiry = 0, User $user = null ) { @@ -24,7 +24,7 @@ class TestBagOStuff extends \CachedBagOStuff { /** * @param string $id Session ID * @param array $metadata Session metadata - * @param int $expiry Expiry + * @param int $expiry */ public function setSessionMeta( $id, array $metadata, $expiry = 0 ) { $this->setSession( $id, [ 'metadata' => $metadata ], $expiry ); @@ -33,7 +33,7 @@ class TestBagOStuff extends \CachedBagOStuff { /** * @param string $id Session ID * @param array $blob Session metadata and data - * @param int $expiry Expiry + * @param int $expiry * @param User $user User for metadata */ public function setSession( $id, array $blob, $expiry = 0, User $user = null ) { @@ -54,7 +54,7 @@ class TestBagOStuff extends \CachedBagOStuff { /** * @param string $id Session ID * @param array|mixed $blob Session metadata and data - * @param int $expiry Expiry + * @param int $expiry */ public function setRawSession( $id, $blob, $expiry = 0 ) { if ( $expiry <= 0 ) { diff --git a/tests/phpunit/includes/session/TestUtils.php b/tests/phpunit/includes/session/TestUtils.php index af29d6bd7d..5db1ad0e6a 100644 --- a/tests/phpunit/includes/session/TestUtils.php +++ b/tests/phpunit/includes/session/TestUtils.php @@ -79,7 +79,7 @@ class TestUtils { * If you need a Session for testing but don't want to create a backend to * construct one, use this. * @param object $backend Object to serve as the SessionBackend - * @param int $index Index + * @param int $index * @param LoggerInterface $logger * @return Session */ diff --git a/tests/phpunit/mocks/content/DummyContentForTesting.php b/tests/phpunit/mocks/content/DummyContentForTesting.php index 4392964982..e8259d3a04 100644 --- a/tests/phpunit/mocks/content/DummyContentForTesting.php +++ b/tests/phpunit/mocks/content/DummyContentForTesting.php @@ -112,7 +112,7 @@ class DummyContentForTesting extends AbstractContent { * * @param Title $title Context title for parsing * @param int|null $revId Revision ID (for {{REVISIONID}}) - * @param ParserOptions $options Parser options + * @param ParserOptions $options * @param bool $generateHtml Whether or not to generate HTML * @param ParserOutput &$output The output object to fill (reference). */ diff --git a/tests/phpunit/mocks/content/DummyNonTextContent.php b/tests/phpunit/mocks/content/DummyNonTextContent.php index afc1a4ae94..91bb1866d6 100644 --- a/tests/phpunit/mocks/content/DummyNonTextContent.php +++ b/tests/phpunit/mocks/content/DummyNonTextContent.php @@ -110,7 +110,7 @@ class DummyNonTextContent extends AbstractContent { * * @param Title $title Context title for parsing * @param int|null $revId Revision ID (for {{REVISIONID}}) - * @param ParserOptions $options Parser options + * @param ParserOptions $options * @param bool $generateHtml Whether or not to generate HTML * @param ParserOutput &$output The output object to fill (reference). */