diff --git a/src/NLog/Abstractions/ILoggerBase.cs b/src/NLog/Abstractions/ILoggerBase.cs index 2d00611965..02642950af 100644 --- a/src/NLog/Abstractions/ILoggerBase.cs +++ b/src/NLog/Abstractions/ILoggerBase.cs @@ -38,6 +38,8 @@ namespace NLog using JetBrains.Annotations; /// + /// Obsolete and replaced by with NLog v5.3. + /// /// Logger with only generic methods (passing 'LogLevel' to methods) and core properties. /// [Obsolete("ILoggerBase should be replaced with ILogger. Marked obsolete with NLog v5.3")] @@ -45,6 +47,7 @@ namespace NLog public partial interface ILoggerBase { /// + /// Obsolete on the ILogger-interface, instead use with NLog v5.3. /// Occurs when logger configuration changes. /// [Obsolete("LoggerReconfigured-EventHandler is very exotic for ILogger-interface. Instead use Logger.LoggerReconfigured. Marked obsolete with NLog v5.3")] @@ -60,6 +63,7 @@ string Name } /// + /// Obsolete on the ILogger-interface, instead use with NLog v5.3. /// Gets the factory that created this logger. /// [Obsolete("Factory-property is hard to mock for ILogger-interface. Instead use Logger.Factory. Marked obsolete with NLog v5.3")] diff --git a/src/NLog/Abstractions/ISuppress.cs b/src/NLog/Abstractions/ISuppress.cs index be5ffd484e..606a0a18d6 100644 --- a/src/NLog/Abstractions/ISuppress.cs +++ b/src/NLog/Abstractions/ISuppress.cs @@ -40,6 +40,8 @@ namespace NLog #endif /// + /// Obsolete and replaced by with NLog v5.3. + /// /// Provides an interface to execute System.Actions without surfacing any exceptions raised for that action. /// [Obsolete("ISuppress should be replaced with ILogger. Marked obsolete with NLog v5.3")] diff --git a/src/NLog/Common/InternalLogger.cs b/src/NLog/Common/InternalLogger.cs index cb0d08528d..e8691ae9b2 100644 --- a/src/NLog/Common/InternalLogger.cs +++ b/src/NLog/Common/InternalLogger.cs @@ -123,6 +123,7 @@ public static bool LogToConsoleError private static bool _logToConsoleError; /// + /// Obsolete and replaced by with NLog v5.3. /// Gets or sets a value indicating whether internal messages should be written to the .Trace /// [Obsolete("Instead use InternalLogger.LogWriter. Marked obsolete with NLog v5.3")] @@ -178,6 +179,7 @@ public static string LogFile public static TextWriter LogWriter { get; set; } /// + /// Obsolete and replaced by with NLog 5.3. /// Event written to the internal log. /// /// diff --git a/src/NLog/Config/LoggingRule.cs b/src/NLog/Config/LoggingRule.cs index 2a4c45983d..0cd9ca1741 100644 --- a/src/NLog/Config/LoggingRule.cs +++ b/src/NLog/Config/LoggingRule.cs @@ -121,6 +121,8 @@ public LoggingRule(string loggerNamePattern, Target target) public IList Targets => _targets; /// + /// Obsolete since too exotic feature with NLog v5.3. + /// /// Gets a collection of child rules to be evaluated when this rule matches. /// [Obsolete("Very exotic feature without any unit-tests, not sure if it works. Marked obsolete with NLog v5.3")] diff --git a/src/NLog/Config/MutableUnsafeAttribute.cs b/src/NLog/Config/MutableUnsafeAttribute.cs index 954517b71b..852ff6f713 100644 --- a/src/NLog/Config/MutableUnsafeAttribute.cs +++ b/src/NLog/Config/MutableUnsafeAttribute.cs @@ -37,6 +37,8 @@ namespace NLog.Config using System.ComponentModel; /// + /// Obsolete and replaced by with NLog v5.3. + /// /// Marks the layout or layout renderer depends on mutable objects from the LogEvent /// /// This can be or diff --git a/src/NLog/Config/XmlLoggingConfiguration.cs b/src/NLog/Config/XmlLoggingConfiguration.cs index 3b45daed11..825acaebf1 100644 --- a/src/NLog/Config/XmlLoggingConfiguration.cs +++ b/src/NLog/Config/XmlLoggingConfiguration.cs @@ -281,6 +281,8 @@ public override LoggingConfiguration Reload() } /// + /// Obsolete and replaced by and with NLog v5.2. + /// /// Get file paths (including filename) for the possible NLog config files. /// /// The file paths to the possible config file @@ -292,6 +294,8 @@ public static IEnumerable GetCandidateConfigFilePaths() } /// + /// Obsolete and replaced by and with NLog v5.2. + /// /// Overwrite the paths (including filename) for the possible NLog config files. /// /// The file paths to the possible config file @@ -303,6 +307,8 @@ public static void SetCandidateConfigFilePaths(IEnumerable filePaths) } /// + /// Obsolete and replaced by and with NLog v5.2. + /// /// Clear the candidate file paths and return to the defaults. /// [Obsolete("Replaced by chaining LogManager.Setup().LoadConfigurationFromFile(). Marked obsolete on NLog 5.2")] diff --git a/src/NLog/Internal/CallSiteInformation.cs b/src/NLog/Internal/CallSiteInformation.cs index 5572b0aa98..6493473a74 100644 --- a/src/NLog/Internal/CallSiteInformation.cs +++ b/src/NLog/Internal/CallSiteInformation.cs @@ -137,6 +137,8 @@ public void SetCallerInfo(string callerClassName, string callerMethodName, strin } /// + /// Obsolete and replaced by or ${callsite} with NLog v5.3. + /// /// Gets the stack frame of the method that did the logging. /// [Obsolete("Instead use ${callsite} or CallerMemberName. Marked obsolete on NLog 5.3")] diff --git a/src/NLog/LayoutRenderers/LayoutRenderer.cs b/src/NLog/LayoutRenderers/LayoutRenderer.cs index efcb11f938..f7795e6351 100644 --- a/src/NLog/LayoutRenderers/LayoutRenderer.cs +++ b/src/NLog/LayoutRenderers/LayoutRenderer.cs @@ -251,7 +251,7 @@ protected CultureInfo GetCulture(LogEventInfo logEvent, CultureInfo layoutCultur } /// - /// Obsolete and replaced by with NLog v5.2 + /// Obsolete and replaced by with NLog v5.2. /// /// Register a custom layout renderer. /// @@ -268,7 +268,7 @@ public static void Register(string name, [DynamicallyAccessedMembers(Dynamically } /// - /// Obsolete and replaced by with NLog v5.2 + /// Obsolete and replaced by with NLog v5.2. /// /// Register a custom layout renderer with a callback function . The callback receives the logEvent. /// @@ -283,7 +283,7 @@ public static void Register(string name, Func func) } /// - /// Obsolete and replaced by with NLog v5.2 + /// Obsolete and replaced by with NLog v5.2. /// /// Register a custom layout renderer with a callback function . The callback receives the logEvent and the current configuration. /// @@ -299,7 +299,7 @@ public static void Register(string name, Func - /// Obsolete and replaced by with NLog v5.2 + /// Obsolete and replaced by with NLog v5.2. /// /// Register a custom layout renderer with a callback function . The callback receives the logEvent and the current configuration. /// diff --git a/src/NLog/LogEventInfo.cs b/src/NLog/LogEventInfo.cs index a80b0b68c7..61bbfe3ec4 100644 --- a/src/NLog/LogEventInfo.cs +++ b/src/NLog/LogEventInfo.cs @@ -217,6 +217,8 @@ public int SequenceID public bool HasStackTrace => CallSiteInformation?.StackTrace != null; /// + /// Obsolete and replaced by or ${callsite} with NLog v5.3. + /// /// Gets the stack frame of the method that did the logging. /// [Obsolete("Instead use ${callsite} or CallerMemberName. Marked obsolete on NLog 5.3")] diff --git a/src/NLog/LogFactory.cs b/src/NLog/LogFactory.cs index 163740c554..7888154885 100644 --- a/src/NLog/LogFactory.cs +++ b/src/NLog/LogFactory.cs @@ -132,6 +132,8 @@ public LogFactory() } /// + /// Obsolete instead use default-constructor, and assign with NLog 5.0. + /// /// Initializes a new instance of the class. /// /// The config. @@ -769,6 +771,8 @@ protected virtual void OnConfigurationChanged(LoggingConfigurationChangedEventAr #if !NETSTANDARD1_3 /// + /// Obsolete and replaced by with NLog 5.2. + /// /// Raises the event when the configuration is reloaded. /// /// Event arguments @@ -906,6 +910,8 @@ public void Shutdown() } /// + /// Obsolete and replaced by and with NLog v5.2. + /// /// Get file paths (including filename) for the possible NLog config files. /// /// The file paths to the possible config file @@ -922,6 +928,8 @@ public IEnumerable GetCandidateConfigFilePaths() } /// + /// Obsolete and replaced by and with NLog v5.2. + /// /// Get file paths (including filename) for the possible NLog config files. /// /// The file paths to the possible config file @@ -935,6 +943,8 @@ internal IEnumerable GetCandidateConfigFilePaths(string filename) } /// + /// Obsolete and replaced by and with NLog v5.2. + /// /// Overwrite the candidates paths (including filename) for the possible NLog config files. /// /// The file paths to the possible config file @@ -951,6 +961,8 @@ public void SetCandidateConfigFilePaths(IEnumerable filePaths) } /// + /// Obsolete and replaced by and with NLog v5.2. + /// /// Clear the candidate file paths and return to the defaults. /// [Obsolete("Replaced by chaining LogFactory.Setup().LoadConfigurationFromFile(). Marked obsolete on NLog 5.2")] @@ -1029,6 +1041,8 @@ internal Logger CreateNewLogger(Type loggerType, Func loggerCreato } /// + /// Obsolete and replaced by and with NLog v5.2. + /// /// Loads logging configuration from file (Currently only XML configuration files supported) /// /// Configuration file to be read