From 41b5aa343f26a45244ae84d509bec797bf6aa48e Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Mon, 23 Nov 2015 22:53:38 +0000 Subject: [PATCH] Remove redundant escaping for namespace references in documentation Follows-up b264cee. No longer needed as of 0c9e9cc. Change-Id: I31745f55885eeec2bb8cf2c9ffe9e98242cd5baa --- includes/GlobalFunctions.php | 2 +- includes/debug/logger/LegacyLogger.php | 6 +++--- includes/debug/logger/LegacySpi.php | 4 ++-- includes/debug/logger/LoggerFactory.php | 14 +++++++------- includes/debug/logger/MonologSpi.php | 8 ++++---- includes/debug/logger/NullSpi.php | 17 ++++++++--------- includes/debug/logger/Spi.php | 8 ++++---- includes/debug/logger/monolog/AvroFormatter.php | 2 +- includes/debug/logger/monolog/BufferHandler.php | 2 +- .../debug/logger/monolog/LegacyFormatter.php | 4 ++-- includes/debug/logger/monolog/LegacyHandler.php | 2 +- includes/debug/logger/monolog/SyslogHandler.php | 2 +- includes/htmlform/HTMLButtonField.php | 2 +- includes/htmlform/HTMLCheckField.php | 2 +- includes/htmlform/HTMLFormField.php | 6 +++--- includes/htmlform/OOUIHTMLForm.php | 2 +- 16 files changed, 41 insertions(+), 42 deletions(-) diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index 421cd90ac0..9566069ee4 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -1238,7 +1238,7 @@ function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) { * @param string $file Filename * @param array $context Additional logging context data * @throws MWException - * @deprecated since 1.25 Use \\MediaWiki\\Logger\\LegacyLogger::emit or UDPTransport + * @deprecated since 1.25 Use \MediaWiki\Logger\LegacyLogger::emit or UDPTransport */ function wfErrorLog( $text, $file, array $context = array() ) { wfDeprecated( __METHOD__, '1.25' ); diff --git a/includes/debug/logger/LegacyLogger.php b/includes/debug/logger/LegacyLogger.php index bb3c7e13e3..65719fa574 100644 --- a/includes/debug/logger/LegacyLogger.php +++ b/includes/debug/logger/LegacyLogger.php @@ -41,7 +41,7 @@ use UDPTransport; * See documentation in DefaultSettings.php for detailed explanations of each * variable. * - * @see \\MediaWiki\\Logger\\LoggerFactory + * @see \MediaWiki\Logger\LoggerFactory * @since 1.25 * @author Bryan Davis * @copyright © 2014 Bryan Davis and Wikimedia Foundation. @@ -54,7 +54,7 @@ class LegacyLogger extends AbstractLogger { protected $channel; /** - * Convert Psr\\Log\\LogLevel constants into int for sane comparisons + * Convert \Psr\Log\LogLevel constants into int for sane comparisons * These are the same values that Monlog uses * * @var array $levelMapping @@ -101,7 +101,7 @@ class LegacyLogger extends AbstractLogger { * * @param string $channel * @param string $message - * @param string|int $level Psr\\Log\\LogEvent constant or Monlog level int + * @param string|int $level \Psr\Log\LogEvent constant or Monlog level int * @param array $context * @return bool True if message should be sent to disk/network, false * otherwise diff --git a/includes/debug/logger/LegacySpi.php b/includes/debug/logger/LegacySpi.php index 6a7f1d0591..1bf39e41b0 100644 --- a/includes/debug/logger/LegacySpi.php +++ b/includes/debug/logger/LegacySpi.php @@ -30,7 +30,7 @@ namespace MediaWiki\Logger; * ); * @endcode * - * @see \\MediaWiki\\Logger\\LoggerFactory + * @see \MediaWiki\Logger\LoggerFactory * @since 1.25 * @author Bryan Davis * @copyright © 2014 Bryan Davis and Wikimedia Foundation. @@ -47,7 +47,7 @@ class LegacySpi implements Spi { * Get a logger instance. * * @param string $channel Logging channel - * @return \\Psr\\Log\\LoggerInterface Logger instance + * @return \Psr\Log\LoggerInterface Logger instance */ public function getLogger( $channel ) { if ( !isset( $this->singletons[$channel] ) ) { diff --git a/includes/debug/logger/LoggerFactory.php b/includes/debug/logger/LoggerFactory.php index 92fbb460ef..1573d7b086 100644 --- a/includes/debug/logger/LoggerFactory.php +++ b/includes/debug/logger/LoggerFactory.php @@ -25,7 +25,7 @@ use ObjectFactory; /** * PSR-3 logger instance factory. * - * Creation of \\Psr\\Log\\LoggerInterface instances is managed via the + * Creation of \Psr\Log\LoggerInterface instances is managed via the * LoggerFactory::getInstance() static method which in turn delegates to the * currently registered service provider. * @@ -38,7 +38,7 @@ use ObjectFactory; * $wgMWLoggerDefaultSpi is expected to be an array usable by * ObjectFactory::getObjectFromSpec() to create a class. * - * @see \\MediaWiki\\Logger\\Spi + * @see \MediaWiki\Logger\Spi * @since 1.25 * @author Bryan Davis * @copyright © 2014 Bryan Davis and Wikimedia Foundation. @@ -47,16 +47,16 @@ class LoggerFactory { /** * Service provider. - * @var \\MediaWiki\\Logger\\Spi $spi + * @var \MediaWiki\Logger\Spi $spi */ private static $spi; /** - * Register a service provider to create new \\Psr\\Log\\LoggerInterface + * Register a service provider to create new \Psr\Log\LoggerInterface * instances. * - * @param \\MediaWiki\\Logger\\Spi $provider Provider to register + * @param \MediaWiki\Logger\Spi $provider Provider to register */ public static function registerProvider( Spi $provider ) { self::$spi = $provider; @@ -71,7 +71,7 @@ class LoggerFactory { * Spi registration. $wgMWLoggerDefaultSpi is expected to be an * array usable by ObjectFactory::getObjectFromSpec() to create a class. * - * @return \\MediaWiki\\Logger\\Spi + * @return \MediaWiki\Logger\Spi * @see registerProvider() * @see ObjectFactory::getObjectFromSpec() */ @@ -91,7 +91,7 @@ class LoggerFactory { * Get a named logger instance from the currently configured logger factory. * * @param string $channel Logger channel (name) - * @return \\Psr\\Log\\LoggerInterface + * @return \Psr\Log\LoggerInterface */ public static function getInstance( $channel ) { static $hasPSR3Interface = null; diff --git a/includes/debug/logger/MonologSpi.php b/includes/debug/logger/MonologSpi.php index 685abe0e49..eea9adc4c4 100644 --- a/includes/debug/logger/MonologSpi.php +++ b/includes/debug/logger/MonologSpi.php @@ -178,7 +178,7 @@ class MonologSpi implements Spi { * name will return the cached instance. * * @param string $channel Logging channel - * @return \\Psr\\Log\\LoggerInterface Logger instance + * @return \Psr\Log\LoggerInterface Logger instance */ public function getLogger( $channel ) { if ( !isset( $this->singletons['loggers'][$channel] ) ) { @@ -200,7 +200,7 @@ class MonologSpi implements Spi { * Create a logger. * @param string $channel Logger channel * @param array $spec Configuration - * @return \\Monolog\\Logger + * @return \Monolog\Logger */ protected function createLogger( $channel, $spec ) { $obj = new Logger( $channel ); @@ -244,7 +244,7 @@ class MonologSpi implements Spi { /** * Create or return cached handler. * @param string $name Processor name - * @return \\Monolog\\Handler\\HandlerInterface + * @return \Monolog\Handler\HandlerInterface */ public function getHandler( $name ) { if ( !isset( $this->singletons['handlers'][$name] ) ) { @@ -267,7 +267,7 @@ class MonologSpi implements Spi { /** * Create or return cached formatter. * @param string $name Formatter name - * @return \\Monolog\\Formatter\\FormatterInterface + * @return \Monolog\Formatter\FormatterInterface */ public function getFormatter( $name ) { if ( !isset( $this->singletons['formatters'][$name] ) ) { diff --git a/includes/debug/logger/NullSpi.php b/includes/debug/logger/NullSpi.php index c9c74821d0..8ae34e83e4 100644 --- a/includes/debug/logger/NullSpi.php +++ b/includes/debug/logger/NullSpi.php @@ -23,17 +23,16 @@ namespace MediaWiki\Logger; use Psr\Log\NullLogger; /** - * LoggerFactory service provider that creates \\Psr\\Log\\NullLogger + * LoggerFactory service provider that creates \Psr\Log\NullLogger * instances. A NullLogger silently discards all log events sent to it. * * Usage: - * @code - * $wgMWLoggerDefaultSpi = array( - * 'class' => '\\MediaWiki\\Logger\\NullSpi', - * ); - * @endcode * - * @see \\MediaWiki\\Logger\\LoggerFactory + * $wgMWLoggerDefaultSpi = array( + * 'class' => '\\MediaWiki\\Logger\\NullSpi', + * ); + * + * @see \MediaWiki\Logger\LoggerFactory * @since 1.25 * @author Bryan Davis * @copyright © 2014 Bryan Davis and Wikimedia Foundation. @@ -41,7 +40,7 @@ use Psr\Log\NullLogger; class NullSpi implements Spi { /** - * @var \\Psr\\Log\\NullLogger $singleton + * @var \Psr\Log\NullLogger $singleton */ protected $singleton; @@ -55,7 +54,7 @@ class NullSpi implements Spi { * Get a logger instance. * * @param string $channel Logging channel - * @return \\Psr\\Log\\NullLogger Logger instance + * @return \Psr\Log\NullLogger Logger instance */ public function getLogger( $channel ) { return $this->singleton; diff --git a/includes/debug/logger/Spi.php b/includes/debug/logger/Spi.php index 51818a38ce..044789f201 100644 --- a/includes/debug/logger/Spi.php +++ b/includes/debug/logger/Spi.php @@ -21,15 +21,15 @@ namespace MediaWiki\Logger; /** - * Service provider interface for \\Psr\\Log\\LoggerInterface implementation + * Service provider interface for \Psr\Log\LoggerInterface implementation * libraries. * * MediaWiki can be configured to use a class implementing this interface to - * create new \\Psr\\Log\\LoggerInterface instances via either the + * create new \Psr\Log\LoggerInterface instances via either the * $wgMWLoggerDefaultSpi global variable or code that constructs an instance * and registers it via the LoggerFactory::registerProvider() static method. * - * @see \\MediaWiki\\Logger\\LoggerFactory + * @see \MediaWiki\Logger\LoggerFactory * @since 1.25 * @author Bryan Davis * @copyright © 2014 Bryan Davis and Wikimedia Foundation. @@ -40,7 +40,7 @@ interface Spi { * Get a logger instance. * * @param string $channel Logging channel - * @return \\Psr\\Log\\LoggerInterface Logger instance + * @return \Psr\Log\LoggerInterface Logger instance */ public function getLogger( $channel ); diff --git a/includes/debug/logger/monolog/AvroFormatter.php b/includes/debug/logger/monolog/AvroFormatter.php index 019d0288d7..09954a0a40 100644 --- a/includes/debug/logger/monolog/AvroFormatter.php +++ b/includes/debug/logger/monolog/AvroFormatter.php @@ -117,7 +117,7 @@ class AvroFormatter implements FormatterInterface { * Get the writer for the named channel * * @var string $channel Name of the schema to fetch - * @return \\AvroSchema|null + * @return \AvroSchema|null */ protected function getSchema( $channel ) { if ( !isset( $this->schemas[$channel] ) ) { diff --git a/includes/debug/logger/monolog/BufferHandler.php b/includes/debug/logger/monolog/BufferHandler.php index 59f8ad44b8..5bcb7d59e4 100644 --- a/includes/debug/logger/monolog/BufferHandler.php +++ b/includes/debug/logger/monolog/BufferHandler.php @@ -26,7 +26,7 @@ use DeferredUpdates; use Monolog\Handler\BufferHandler as BaseBufferHandler; /** - * Updates \\Monolog\\Handler\\BufferHandler to use DeferredUpdates rather + * Updates \Monolog\Handler\BufferHandler to use DeferredUpdates rather * than register_shutdown_function. On supported platforms this will * use register_postsend_function or fastcgi_finish_request() to delay * until after the request has shutdown and we are no longer delaying diff --git a/includes/debug/logger/monolog/LegacyFormatter.php b/includes/debug/logger/monolog/LegacyFormatter.php index 42e7cabad2..9ec15cb85b 100644 --- a/includes/debug/logger/monolog/LegacyFormatter.php +++ b/includes/debug/logger/monolog/LegacyFormatter.php @@ -26,12 +26,12 @@ use Monolog\Formatter\NormalizerFormatter; /** * Log message formatter that mimics the legacy log message formatting of * `wfDebug`, `wfDebugLog`, `wfLogDBError` and `wfErrorLog` global functions by - * delegating the formatting to \\MediaWiki\\Logger\\LegacyLogger. + * delegating the formatting to \MediaWiki\Logger\LegacyLogger. * * @since 1.25 * @author Bryan Davis * @copyright © 2013 Bryan Davis and Wikimedia Foundation. - * @see \\MediaWiki\\Logger\\LegacyLogger + * @see \MediaWiki\Logger\LegacyLogger */ class LegacyFormatter extends NormalizerFormatter { diff --git a/includes/debug/logger/monolog/LegacyHandler.php b/includes/debug/logger/monolog/LegacyHandler.php index 0079871f5c..a4bb17268f 100644 --- a/includes/debug/logger/monolog/LegacyHandler.php +++ b/includes/debug/logger/monolog/LegacyHandler.php @@ -41,7 +41,7 @@ use UnexpectedValueException; * channel as the prefix value. * * When not targeting a udp2log stream this class will act as a drop-in - * replacement for \\Monolog\\Handler\\StreamHandler. + * replacement for \Monolog\Handler\StreamHandler. * * @since 1.25 * @author Bryan Davis diff --git a/includes/debug/logger/monolog/SyslogHandler.php b/includes/debug/logger/monolog/SyslogHandler.php index 2e6dbe2900..2614b16ce8 100644 --- a/includes/debug/logger/monolog/SyslogHandler.php +++ b/includes/debug/logger/monolog/SyslogHandler.php @@ -30,7 +30,7 @@ use Monolog\Logger; * Monolog's SyslogUdpHandler creates a partial RFC 5424 header (PRI and * VERSION) and relies on the associated formatter to complete the header and * message payload. This makes using it with a fixed format formatter like - * \\Monolog\\Formatter\\LogstashFormatter impossible. Additionally, the + * \Monolog\Formatter\LogstashFormatter impossible. Additionally, the * direct syslog input for Logstash only handles RFC 3164 syslog packets. * * This Handler should work with any Formatter. The formatted message will be diff --git a/includes/htmlform/HTMLButtonField.php b/includes/htmlform/HTMLButtonField.php index 5a1006a3c9..1d45e5f46d 100644 --- a/includes/htmlform/HTMLButtonField.php +++ b/includes/htmlform/HTMLButtonField.php @@ -45,7 +45,7 @@ class HTMLButtonField extends HTMLFormField { /** * Get the OOUI widget for this field. * @param string $value - * @return OOUI\\ButtonInputWidget + * @return OOUI\ButtonInputWidget */ public function getInputOOUI( $value ) { return new OOUI\ButtonInputWidget( array( diff --git a/includes/htmlform/HTMLCheckField.php b/includes/htmlform/HTMLCheckField.php index b2268546fa..5ef4f79fda 100644 --- a/includes/htmlform/HTMLCheckField.php +++ b/includes/htmlform/HTMLCheckField.php @@ -45,7 +45,7 @@ class HTMLCheckField extends HTMLFormField { * Get the OOUI version of this field. * @since 1.26 * @param string $value - * @return OOUI\\CheckboxInputWidget The checkbox widget. + * @return OOUI\CheckboxInputWidget The checkbox widget. */ public function getInputOOUI( $value ) { if ( !empty( $this->mParams['invert'] ) ) { diff --git a/includes/htmlform/HTMLFormField.php b/includes/htmlform/HTMLFormField.php index 28bfb66319..d4a293eb63 100644 --- a/includes/htmlform/HTMLFormField.php +++ b/includes/htmlform/HTMLFormField.php @@ -49,7 +49,7 @@ abstract class HTMLFormField { * Defaults to false, which getOOUI will interpret as "use the HTML version" * * @param string $value - * @return OOUI\\Widget|false + * @return OOUI\Widget|false */ function getInputOOUI( $value ) { return false; @@ -576,7 +576,7 @@ abstract class HTMLFormField { * * @param string $value The value to set the input to. * - * @return OOUI\\FieldLayout|OOUI\\ActionFieldLayout + * @return OOUI\FieldLayout|OOUI\ActionFieldLayout */ public function getOOUI( $value ) { $inputField = $this->getInputOOUI( $value ); @@ -629,7 +629,7 @@ abstract class HTMLFormField { /** * Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output. - * @return OOUI\\FieldLayout|OOUI\\ActionFieldLayout + * @return OOUI\FieldLayout|OOUI\ActionFieldLayout */ protected function getFieldLayoutOOUI( $inputField, $config ) { if ( isset( $this->mClassWithButton ) ) { diff --git a/includes/htmlform/OOUIHTMLForm.php b/includes/htmlform/OOUIHTMLForm.php index 3238c2cc5f..c11449ad48 100644 --- a/includes/htmlform/OOUIHTMLForm.php +++ b/includes/htmlform/OOUIHTMLForm.php @@ -133,7 +133,7 @@ class OOUIHTMLForm extends HTMLForm { /** * Put a form section together from the individual fields' HTML, merging it and wrapping. - * @param OOUI\\FieldLayout[] $fieldsHtml + * @param OOUI\FieldLayout[] $fieldsHtml * @param string $sectionName * @param bool $anyFieldHasLabel Unused * @return string HTML -- 2.20.1