From 760c1a16b6f043d0cb9ac11def2fd2a03ede7f53 Mon Sep 17 00:00:00 2001 From: Florian Date: Mon, 20 Jul 2015 20:05:02 +0200 Subject: [PATCH] Fix doxygen warnings for missing commands Follow up: I14c4d7521f81ddd8c7b56facc1f0ae34f86b2299 Change-Id: I8c69f52da577b3baecc622e3fab16f7c7b3db1f5 --- includes/debug/logger/LegacyLogger.php | 8 ++++---- includes/debug/logger/LegacySpi.php | 4 ++-- includes/debug/logger/LoggerFactory.php | 12 ++++++------ includes/debug/logger/MonologSpi.php | 10 +++++----- includes/debug/logger/NullSpi.php | 8 ++++---- includes/debug/logger/Spi.php | 8 ++++---- includes/debug/logger/monolog/LegacyFormatter.php | 4 ++-- 7 files changed, 27 insertions(+), 27 deletions(-) diff --git a/includes/debug/logger/LegacyLogger.php b/includes/debug/logger/LegacyLogger.php index 80107908fc..ea4e1b1413 100644 --- a/includes/debug/logger/LegacyLogger.php +++ b/includes/debug/logger/LegacyLogger.php @@ -40,7 +40,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. @@ -53,10 +53,10 @@ 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 + * @var array $levelMapping */ protected static $levelMapping = array( LogLevel::DEBUG => 100, @@ -100,7 +100,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 1bf39e41b0..6a7f1d0591 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 f6699ec4f5..0b6965ffd2 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. @@ -53,10 +53,10 @@ class LoggerFactory { /** - * 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 ) { if ( !interface_exists( '\Psr\Log\LoggerInterface' ) ) { diff --git a/includes/debug/logger/MonologSpi.php b/includes/debug/logger/MonologSpi.php index e32e0b2263..7b54861127 100644 --- a/includes/debug/logger/MonologSpi.php +++ b/includes/debug/logger/MonologSpi.php @@ -30,7 +30,7 @@ use ObjectFactory; * Configured using an array of configuration data with the keys 'loggers', * 'processors', 'handlers' and 'formatters'. * - * The ['loggers']['@default'] configuration will be used to create loggers + * The ['loggers']['\@default'] configuration will be used to create loggers * for any channel that isn't explicitly named in the 'loggers' configuration * section. * @@ -176,7 +176,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] ) ) { @@ -198,7 +198,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 ); @@ -236,7 +236,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] ) ) { @@ -256,7 +256,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 a82d2c4c22..c9c74821d0 100644 --- a/includes/debug/logger/NullSpi.php +++ b/includes/debug/logger/NullSpi.php @@ -23,7 +23,7 @@ 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: @@ -33,7 +33,7 @@ use Psr\Log\NullLogger; * ); * @endcode * - * @see \MediaWiki\Logger\LoggerFactory + * @see \\MediaWiki\\Logger\\LoggerFactory * @since 1.25 * @author Bryan Davis * @copyright © 2014 Bryan Davis and Wikimedia Foundation. @@ -41,7 +41,7 @@ use Psr\Log\NullLogger; class NullSpi implements Spi { /** - * @var \Psr\Log\NullLogger $singleton + * @var \\Psr\\Log\\NullLogger $singleton */ protected $singleton; @@ -55,7 +55,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 044789f201..51818a38ce 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/LegacyFormatter.php b/includes/debug/logger/monolog/LegacyFormatter.php index 9ec15cb85b..42e7cabad2 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 { -- 2.20.1