Fix namespaced class references for Doxygen

Doxygen doesn't quite grok PHP's use of the reverse solidus (backslash)
character as a namespace separator. The C++ based parser it uses needs
them to be escaped in comments just as if they were being used in
a literal string context in PHP.

Change-Id: I9aff9dd0fb74a95039da1091c2f247cf71fd085a

diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php
index c24aaec..243df92 100644 (file)
--- a/includes/GlobalFunctions.php
+++ b/includes/GlobalFunctions.php
@@ -1233,7 +1233,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/LoggerFactory.php b/includes/debug/logger/LoggerFactory.php
index 0b6965f..f1b24e7 100644 (file)
--- a/includes/debug/logger/LoggerFactory.php
+++ b/includes/debug/logger/LoggerFactory.php
@@ -47,7 +47,7 @@ class LoggerFactory {
 
        /**
         * Service provider.
-        * @var \MediaWiki\Logger\Spi $spi
+        * @var \\MediaWiki\\Logger\\Spi $spi
         */
        private static $spi;
 

diff --git a/includes/debug/logger/monolog/AvroFormatter.php b/includes/debug/logger/monolog/AvroFormatter.php
index b6adab4..019d028 100644 (file)
--- 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 d53ccde..59f8ad4 100644 (file)
--- 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 the Monolog 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/LegacyHandler.php b/includes/debug/logger/monolog/LegacyHandler.php
index 8405819..0079871 100644 (file)
--- 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's StreamHandler.
+ * replacement for \\Monolog\\Handler\\StreamHandler.
  *
  * @since 1.25
  * @author Bryan Davis <bd808@wikimedia.org>

diff --git a/includes/debug/logger/monolog/SyslogHandler.php b/includes/debug/logger/monolog/SyslogHandler.php
index 008efbc..2e6dbe2 100644 (file)
--- a/includes/debug/logger/monolog/SyslogHandler.php
+++ b/includes/debug/logger/monolog/SyslogHandler.php
@@ -30,8 +30,8 @@ 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 direct
- * syslog input for Logstash only handles RFC 3164 syslog packets.
+ * \\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
  * prepended with an RFC 3164 message header and a partial message body. The