/**
* @since 1.26
- * @param string $name Unprefixed name of the cookie to set
+ * @param string $key Unprefixed name of the cookie to set
* @param string|null $value Value of the cookie to set
* @param string|null $prefix Cookie prefix. Defaults to $wgCookiePrefix
*/
* (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
* PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
*
- * @param string ... strings to escape and glue together, or a single array of strings parameter
+ * @param string $args,... strings to escape and glue together,
+ * or a single array of strings parameter
* @return string
*/
function wfEscapeShellArg( /*...*/ ) {
*
* @since 1.17
*
- * @param mixed ... Parameters as strings or arrays from
+ * @param mixed $args,... Parameters as strings or arrays from
* Message::numParam() and the like, or a single array of parameters.
*
* @return Message $this
* Add one or more head items to the output
*
* @since 1.28
- * @param string|string[] $value Raw HTML
+ * @param string|string[] $values Raw HTML
*/
public function addHeadItems( $values ) {
$this->mHeadItems = array_merge( $this->mHeadItems, (array)$values );
* Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
*
* @since 1.27
- * @param string $remotePath URL path prefix that points to $localPath
+ * @param string $remotePathPrefix URL path prefix that points to $localPath
* @param string $localPath File directory exposed at $remotePath
* @param string $file Path to target file relative to $localPath
* @return string URL
/**
* Logs successful or failed authentication.
- * @param string|AuthenticationResponse $result Response or error message
* @param string $event Event type (e.g. 'accountcreation')
+ * @param string|AuthenticationResponse $result Response or error message
*/
public function logAuthenticationResult( $event, $result ) {
if ( is_string( $result ) ) {
/**
* Fetch the standard parameters this helper recognizes
* @param string $action AuthManager action
- * @param string $param... Parameters to use
+ * @param string $param,... Parameters to use
* @return array
*/
public static function getStandardParams( $action, $param /* ... */ ) {
/**
* Set the continuation manager
- * @param ApiContinuationManager|null
+ * @param ApiContinuationManager|null $manager
*/
public function setContinuationManager( $manager ) {
// Main module has setContinuationManager() method overridden
/**
* Set the continuation manager
- * @param ApiContinuationManager|null
+ * @param ApiContinuationManager|null $manager
*/
public function setContinuationManager( $manager ) {
if ( $manager !== null ) {
* one ( to support the continue parameter )
* - namespace: mandatory
* - search engine profiles defined by SearchApi::getSearchProfileParams()
- * @param string[]|null API request params (must be sanitized by
+ * @param string[]|null $params API request params (must be sanitized by
* ApiBase::extractRequestParams() before)
* @return SearchEngine the search engine
*/
* @note This assumes $alphabet does not contain U+F3000-U+F303F
*
* @param array $alphabet Sorted array of uppercase characters.
- * @param Language $language What language for number sorting.
+ * @param Language $lang What language for number sorting.
*/
public function __construct( array $alphabet, Language $lang ) {
// It'd be trivial to extend this past 64, you'd just
* @since 1.18
* @param string|string[]|MessageSpecifier $key Message key, or array of keys,
* or a MessageSpecifier.
- * @param mixed ...
+ * @param mixed $args,...
* @return Message
*/
public function msg( $key /* $args */ ) {
*
* @param string|string[]|MessageSpecifier $key Message key, or array of keys,
* or a MessageSpecifier.
- * @param mixed ...
+ * @param mixed $args,...
* @return Message
*/
public function msg( $key ) {
* Construct a HTMLForm object for given display type. May return a HTMLForm subclass.
*
* @param string $displayFormat
- * @param mixed $arguments... Additional arguments to pass to the constructor.
+ * @param mixed $arguments,... Additional arguments to pass to the constructor.
* @return HTMLForm
*/
public static function factory( $displayFormat/*, $arguments...*/ ) {
*
* Like MemoizedCallable::invokeArgs(), but variadic.
*
- * @param mixed ...$params Parameters for memoized function or method.
+ * @param mixed $params,... Parameters for memoized function or method.
* @return mixed The memoized callable's return value.
*/
public function invoke() {
/**
* Register a logger
*
- * @param LoggerInterface
+ * @param LoggerInterface $logger
*/
public function setLogger( LoggerInterface $logger ) {
$this->logger = $logger;
* - StatusValue::newGood() if this method is called without parameters
* - StatusValue::newFatal() with all parameters to this method if passed in
*
- * @param ... string
+ * @param string $args,...
* @return StatusValue
*/
final protected function newStatus() {
* Make a global cache key.
*
* @since 1.27
- * @param string ... Key component (variadic)
+ * @param string $keys,... Key component
* @return string
*/
public function makeGlobalKey() {
* Make a cache key, scoped to this instance's keyspace.
*
* @since 1.27
- * @param string ... Key component (variadic)
+ * @param string $keys,... Key component
* @return string
*/
public function makeKey() {
* @param integer $count
* @param bool $asyncWrites
* @param string $method
- * @param mixed ...
+ * @param mixed $args,...
* @return bool
*/
protected function doWrite( $count, $asyncWrites, $method /*, ... */ ) {
/**
* @see BagOStuff::makeKey()
- * @param string ... Key component
+ * @param string $keys,... Key component
* @return string
* @since 1.27
*/
/**
* @see BagOStuff::makeGlobalKey()
- * @param string ... Key component
+ * @param string $keys,... Key component
* @return string
* @since 1.27
*/
* @see WANObjectCache::getWithSetCallback()
*
* @param IDatabase $db1
- * @param IDatabase ...
+ * @param IDatabase $dbs,...
* @return array Map of values:
* - lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
* - since: oldest UNIX timestamp of any of the DB lag estimates
*
* Sub-classes will extend the required keys in $conf with additional parameters
*
- * @param $conf $params Array with keys:
+ * @param array $conf Array with keys:
* - localDomain: A DatabaseDomain or domain ID string.
* - readOnlyReason : Reason the master DB is read-only if so [optional]
* - srvCache : BagOStuff object for server cache [optional]
*
* @param IContextSource|Skin $context Context to use; formerly it was
* a Skin object. Use of Skin is deprecated.
- * @param LinkRenderer|null $linkRenderer, previously unused
+ * @param LinkRenderer|null $linkRenderer previously unused
* @param int $flags Can be a combination of self::NO_ACTION_LINK,
* self::NO_EXTRA_USER_LINKS or self::USE_CHECKBOXES.
*/
* @param MailAddress $from Sender's email
* @param string $subject Email's subject.
* @param string $body Email's text or Array of two strings to be the text and html bodies
- * @param array $options:
+ * @param array $options Keys:
* 'replyTo' MailAddress
* 'contentType' string default 'text/plain; charset=UTF-8'
* 'headers' array Extra headers to set
* @param MailAddress $from Sender's email
* @param string $subject Email's subject.
* @param string $body Email's text or Array of two strings to be the text and html bodies
- * @param array $options:
+ * @param array $options Keys:
* 'replyTo' MailAddress
* 'contentType' string default 'text/plain; charset=UTF-8'
* 'headers' array Extra headers to set
/**
* Extracts the image size and WebP type from a file
*
- * @param string $chunks Chunks as extracted by RiffExtractor
+ * @param string $filename
* @return array|bool Header data array with entries 'compression', 'width' and 'height',
* where 'compression' can be 'lossy', 'lossless', 'animated' or 'unknown'. False if
* file is not a valid WebP file.
* is it allowed in the specific case of parsing this page.
* @see self::getAllowUnsafeRawHtml()
* @since 1.29
- * @param bool|null Value to set or null to get current value
+ * @param bool|null $x Value to set or null to get current value
* @return bool Current value for allowUnsafeRawHtml
*/
public function setAllowUnsafeRawHtml( $x ) {
*
* @since 1.26
* @param ResourceLoaderContext $context
- * @param string[] $modules List of known module names
+ * @param string[] $moduleNames List of known module names
* @return string Hash
*/
public function getCombinedVersion( ResourceLoaderContext $context, array $moduleNames ) {
* @since 1.27
* @param string|string[]|MessageSpecifier $key Message key, or array of keys,
* or a MessageSpecifier.
- * @param mixed ...
+ * @param mixed $args,...
* @return Message
*/
public function msg( $key ) {
/**
* A hook for setVisibility(): do any necessary updates post-commit.
* STUB
- * @param array [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
+ * @param array $visibilityChangeMap [id => ['oldBits' => $oldBits, 'newBits' => $newBits], ... ]
* @return Status
*/
public function doPostCommitUpdates( array $visibilityChangeMap ) {
* to not be in the results or be lower down the list.
* @param string $search the query
* @param int[] $namespaces the namespaces
- * @param int $limit the max number of results to return
* @param string[] $srchres results
+ * @param int $limit the max number of results to return
* @return string[] munged results
*/
public function rescore( $search, $namespaces, $srchres, $limit ) {
/**
* Construct a new suggestion
* @param float $score the suggestion score
- * @param string $text|null the suggestion text
+ * @param string|null $text the suggestion text
* @param Title|null $suggestedTitle the suggested title
* @param int|null $suggestedTitleID the suggested title ID
*/
* @private Use self::install().
* @param SessionManager $manager
* @param BagOStuff $store
- * @param LoggerInterface $store
+ * @param LoggerInterface $logger
*/
public function setManager(
SessionManager $manager, BagOStuff $store, LoggerInterface $logger
* reset whatever token it does use here.
*
* @protected For use by \MediaWiki\Session\SessionManager only
- * @param User $user;
+ * @param User $user
*/
public function invalidateSessionsForUser( User $user ) {
}
* Get a Message object with its context set
*
* @param string $name Message name
- * @param ... $params Message params
+ * @param mixed $params,... Message params
* @return Message
*/
public function getMsg( $name /* ... */ ) {
/**
* Implement by redirecting through Special:Redirect/file.
*
- * @param string|null $subpage
+ * @param string|null $par
* @return Title
*/
public function getRedirect( $par ) {
*
* @param string $mime mime type (e.g. image/jpeg)
* @param int $count Number of images of this type
- * @param int $totalBytes Total space for images of this type
+ * @param int $bytes Total space for images of this type
*/
protected function outputTableRow( $mime, $count, $bytes ) {
$mimeSearch = SpecialPage::getTitleFor( 'MIMEsearch', $mime );
/**
* Check if user is allowed to access a feature / make an action
*
- * @param string ... Permissions to test
+ * @param string $permissions,... Permissions to test
* @return bool True if user is allowed to perform *any* of the given actions
*/
public function isAllowedAny() {
/**
*
- * @param string ... Permissions to test
+ * @param string $permissions,... Permissions to test
* @return bool True if the user is allowed to perform *all* of the given actions
*/
public function isAllowedAll() {
/**
* Accepts the next token in an expect sequence
*
- * @param array
+ * @param array $token
*/
protected function tryEndExpect( $token ) {
switch ( $this->startToken[0] ) {
<exclude name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
<exclude name="MediaWiki.Commenting.FunctionComment.Missing.Protected" />
<exclude name="MediaWiki.Commenting.FunctionComment.Missing.Public" />
- <exclude name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Commenting.FunctionComment.SpacingAfter" />
<exclude name="MediaWiki.Commenting.FunctionComment.SpacingAfterParamName" />
<exclude name="MediaWiki.Commenting.FunctionComment.SpacingAfterParamType" />
* @see staticSetup
*
* @param array $teardown The snippet array
- * @param ScopedCallback|null A ScopedCallback to consume
+ * @param ScopedCallback|null $nextTeardown A ScopedCallback to consume
* @return ScopedCallback
*/
protected function createTeardownObject( $teardown, $nextTeardown = null ) {
* @dataProvider provideTestForAccountCreation
* @param string $msg
* @param Status|null $status
- * @param StatusValue Result
+ * @param StatusValue $result Result
*/
public function testTestForAccountCreation( $msg, $status, $result ) {
$this->hook( 'AbortNewAccount', $this->once() )
dépôts / lhc / web / wiklou.git / commitdiff