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
This commit is contained in:
parent
c9c12a28a6
commit
ef470ebf7f
59 changed files with 96 additions and 98 deletions
|
|
@ -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 = '' ) {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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' ) {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 = [] ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 );
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
2
includes/cache/CacheDependency.php
vendored
2
includes/cache/CacheDependency.php
vendored
|
|
@ -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
|
||||
|
|
|
|||
2
includes/cache/GenderCache.php
vendored
2
includes/cache/GenderCache.php
vendored
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
10
includes/cache/MessageCache.php
vendored
10
includes/cache/MessageCache.php
vendored
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
*
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ class TransactionProfiler implements LoggerAwareInterface {
|
|||
}
|
||||
|
||||
/**
|
||||
* @param bool $value New value
|
||||
* @param bool $value
|
||||
* @return bool Old value
|
||||
* @since 1.28
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 );
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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() )
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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 ) {
|
||||
|
|
|
|||
|
|
@ -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
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
*/
|
||||
|
|
|
|||
Loading…
Reference in a new issue