Add description for LegacyLoggerFactory

diff --git a/src/Core/Logger/Factory/LegacyLoggerFactory.php b/src/Core/Logger/Factory/LegacyLoggerFactory.php
index 485f3b09dcea64636bea57eb90e65ffdff03733a..5c91d11771c8fa0e3b0027ff86ac0a0ecdf1e321 100644 (file)
--- a/src/Core/Logger/Factory/LegacyLoggerFactory.php
+++ b/src/Core/Logger/Factory/LegacyLoggerFactory.php
@@ -15,7 +15,17 @@ use Friendica\Util\Profiler;
 use Psr\Log\LoggerInterface;
 
 /**
- * Manager for the core logging instances
+ * Bridge for the legacy Logger factory.
+ *
+ * This class can be removed after the following classes are replaced or
+ * refactored implementing the `\Friendica\Core\Logger\Factory\LoggerFactory`:
+ *
+ * - Friendica\Core\Logger\Factory\StreamLogger
+ * - Friendica\Core\Logger\Factory\SyslogLogger
+ * - monolog addon: Friendica\Addon\monolog\src\Factory\Monolog
+ *
+ * @see \Friendica\Core\Logger\Factory\StreamLogger
+ * @see \Friendica\Core\Logger\Factory\SyslogLogger
  */
 final class LegacyLoggerFactory implements LoggerFactory
 {