Remove redundant escaping for namespace references in documentation
authorTimo Tijhof <krinklemail@gmail.com>
Mon, 23 Nov 2015 22:53:38 +0000 (22:53 +0000)
committerKrinkle <krinklemail@gmail.com>
Mon, 23 Nov 2015 23:02:32 +0000 (23:02 +0000)
Follows-up b264cee. No longer needed as of 0c9e9cc.

Change-Id: I31745f55885eeec2bb8cf2c9ffe9e98242cd5baa

16 files changed:
includes/GlobalFunctions.php
includes/debug/logger/LegacyLogger.php
includes/debug/logger/LegacySpi.php
includes/debug/logger/LoggerFactory.php
includes/debug/logger/MonologSpi.php
includes/debug/logger/NullSpi.php
includes/debug/logger/Spi.php
includes/debug/logger/monolog/AvroFormatter.php
includes/debug/logger/monolog/BufferHandler.php
includes/debug/logger/monolog/LegacyFormatter.php
includes/debug/logger/monolog/LegacyHandler.php
includes/debug/logger/monolog/SyslogHandler.php
includes/htmlform/HTMLButtonField.php
includes/htmlform/HTMLCheckField.php
includes/htmlform/HTMLFormField.php
includes/htmlform/OOUIHTMLForm.php

index 421cd90..9566069 100644 (file)
@@ -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' );
index bb3c7e1..65719fa 100644 (file)
@@ -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 <bd808@wikimedia.org>
  * @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
index 6a7f1d0..1bf39e4 100644 (file)
@@ -30,7 +30,7 @@ namespace MediaWiki\Logger;
  * );
  * @endcode
  *
- * @see \\MediaWiki\\Logger\\LoggerFactory
+ * @see \MediaWiki\Logger\LoggerFactory
  * @since 1.25
  * @author Bryan Davis <bd808@wikimedia.org>
  * @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] ) ) {
index 92fbb46..1573d7b 100644 (file)
@@ -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 <bd808@wikimedia.org>
  * @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;
index 685abe0..eea9adc 100644 (file)
@@ -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] ) ) {
index c9c7482..8ae34e8 100644 (file)
@@ -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 <bd808@wikimedia.org>
  * @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;
index 51818a3..044789f 100644 (file)
 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 <bd808@wikimedia.org>
  * @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 );
 
index 019d028..09954a0 100644 (file)
@@ -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] ) ) {
index 59f8ad4..5bcb7d5 100644 (file)
@@ -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
index 42e7cab..9ec15cb 100644 (file)
@@ -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 <bd808@wikimedia.org>
  * @copyright © 2013 Bryan Davis and Wikimedia Foundation.
- * @see \\MediaWiki\\Logger\\LegacyLogger
+ * @see \MediaWiki\Logger\LegacyLogger
  */
 class LegacyFormatter extends NormalizerFormatter {
 
index 0079871..a4bb172 100644 (file)
@@ -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 <bd808@wikimedia.org>
index 2e6dbe2..2614b16 100644 (file)
@@ -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
index 5a1006a..1d45e5f 100644 (file)
@@ -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(
index b226854..5ef4f79 100644 (file)
@@ -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'] ) ) {
index 28bfb66..d4a293e 100644 (file)
@@ -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 ) ) {
index 3238c2c..c11449a 100644 (file)
@@ -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