From e103e942641dd51f8fb9bbe7826b571629a56065 Mon Sep 17 00:00:00 2001 From: Jan Friedrich Date: Fri, 20 Feb 2026 15:55:53 +0100 Subject: [PATCH 1/2] #281 fix hints and warnings --- src/log4net/Appender/AdoNetAppender.cs | 12 +-- src/log4net/Appender/AppenderSkeleton.cs | 22 ++-- .../Appender/BufferingAppenderSkeleton.cs | 24 ++--- .../Appender/BufferingForwardingAppender.cs | 2 +- src/log4net/Appender/DebugAppender.cs | 6 +- src/log4net/Appender/EventLogAppender.cs | 16 +-- src/log4net/Appender/ForwardingAppender.cs | 2 +- src/log4net/Appender/IFlushable.cs | 2 +- src/log4net/Appender/RollingFileAppender.cs | 10 +- src/log4net/Appender/SmtpAppender.cs | 4 +- src/log4net/Appender/TextWriterAppender.cs | 6 +- src/log4net/Appender/TraceAppender.cs | 4 +- .../Config/XmlConfiguratorAttribute.cs | 8 +- src/log4net/Core/DefaultRepositorySelector.cs | 6 +- src/log4net/Core/ExceptionEvaluator.cs | 4 +- src/log4net/Core/IAppenderAttachable.cs | 6 +- src/log4net/Core/ILogger.cs | 4 +- src/log4net/Core/IRepositorySelector.cs | 2 +- src/log4net/Core/ITriggeringEventEvaluator.cs | 4 +- src/log4net/Core/LevelCollection.cs | 90 ++++++++-------- src/log4net/Core/LevelEvaluator.cs | 4 +- src/log4net/Core/LevelMap.cs | 2 +- src/log4net/Core/LocationInfo.cs | 2 +- src/log4net/Core/LogImpl.cs | 24 ++--- src/log4net/Core/LoggerManager.cs | 16 +-- src/log4net/Core/LoggerWrapperImpl.cs | 2 +- src/log4net/Core/SecurityContext.cs | 2 +- src/log4net/Core/TimeEvaluator.cs | 4 +- src/log4net/Filter/FilterSkeleton.cs | 2 +- src/log4net/Filter/LevelMatchFilter.cs | 4 +- src/log4net/Filter/LevelRangeFilter.cs | 4 +- src/log4net/Filter/LoggerMatchFilter.cs | 6 +- src/log4net/Filter/StringMatchFilter.cs | 2 +- src/log4net/GlobalContext.cs | 2 +- src/log4net/ILog.cs | 10 +- src/log4net/Layout/ILayout.cs | 6 +- src/log4net/Layout/LayoutSkeleton.cs | 10 +- .../Layout/Pattern/PatternLayoutConverter.cs | 8 +- .../Pattern/PropertyPatternConverter.cs | 4 +- src/log4net/Layout/RawLayoutConverter.cs | 2 +- src/log4net/Layout/RawPropertyLayout.cs | 2 +- src/log4net/Layout/XmlLayoutBase.cs | 8 +- src/log4net/LogManager.cs | 28 ++--- src/log4net/LogicalThreadContext.cs | 6 +- src/log4net/MDC.cs | 6 +- src/log4net/NDC.cs | 10 +- src/log4net/ObjectRenderer/DefaultRenderer.cs | 2 +- src/log4net/ObjectRenderer/RendererMap.cs | 4 +- src/log4net/Plugin/PluginCollection.cs | 102 +++++++++--------- src/log4net/Plugin/PluginMap.cs | 2 +- .../Hierarchy/DefaultLoggerFactory.cs | 2 +- .../Repository/Hierarchy/ILoggerFactory.cs | 2 +- .../Repository/Hierarchy/RootLogger.cs | 6 +- .../Hierarchy/XmlHierarchyConfigurator.cs | 10 +- src/log4net/Repository/ILoggerRepository.cs | 4 +- .../Repository/LoggerRepositorySkeleton.cs | 4 +- src/log4net/ThreadContext.cs | 6 +- src/log4net/Util/AppenderAttachedImpl.cs | 4 +- src/log4net/Util/CompositeProperties.cs | 2 +- src/log4net/Util/CyclicBuffer.cs | 6 +- src/log4net/Util/EmptyCollection.cs | 2 +- src/log4net/Util/EmptyDictionary.cs | 16 +-- src/log4net/Util/GlobalContextProperties.cs | 6 +- src/log4net/Util/LogLog.cs | 26 ++--- .../Util/LogicalThreadContextProperties.cs | 2 +- src/log4net/Util/LogicalThreadContextStack.cs | 4 +- src/log4net/Util/NativeError.cs | 2 +- src/log4net/Util/NullDictionaryEnumerator.cs | 4 +- src/log4net/Util/NullEnumerator.cs | 4 +- src/log4net/Util/NullSecurityContext.cs | 4 +- src/log4net/Util/OptionConverter.cs | 10 +- src/log4net/Util/PatternParser.cs | 4 +- src/log4net/Util/PatternString.cs | 2 +- .../AppSettingPatternConverter.cs | 2 +- .../PropertyPatternConverter.cs | 2 +- src/log4net/Util/PropertiesDictionary.cs | 4 +- src/log4net/Util/QuietTextWriter.cs | 2 +- src/log4net/Util/ReaderWriterLock.cs | 4 +- src/log4net/Util/SystemInfo.cs | 40 +++---- src/log4net/Util/SystemStringFormat.cs | 2 +- src/log4net/Util/ThreadContextStack.cs | 4 +- .../Util/TypeConverters/BooleanConverter.cs | 4 +- .../Util/TypeConverters/ConverterRegistry.cs | 8 +- .../Util/TypeConverters/EncodingConverter.cs | 2 +- .../Util/TypeConverters/IPAddressConverter.cs | 2 +- .../TypeConverters/PatternLayoutConverter.cs | 2 +- .../TypeConverters/PatternStringConverter.cs | 4 +- .../Util/TypeConverters/TypeConverter.cs | 2 +- .../TypeConverters/TypeConverterAttribute.cs | 2 +- 89 files changed, 369 insertions(+), 369 deletions(-) diff --git a/src/log4net/Appender/AdoNetAppender.cs b/src/log4net/Appender/AdoNetAppender.cs index f720dfdf..fa4d90cc 100644 --- a/src/log4net/Appender/AdoNetAppender.cs +++ b/src/log4net/Appender/AdoNetAppender.cs @@ -270,8 +270,8 @@ public AdoNetAppender() /// Should transactions be used to insert logging events in the database. /// /// - /// true if transactions should be used to insert logging events in - /// the database, otherwise false. The default value is true. + /// if transactions should be used to insert logging events in + /// the database, otherwise . The default value is . /// /// /// @@ -306,8 +306,8 @@ public AdoNetAppender() /// Should this appender try to reconnect to the database on error. /// /// - /// true if the appender should try to reconnect to the database after an - /// error has occurred, otherwise false. The default value is false, + /// if the appender should try to reconnect to the database after an + /// error has occurred, otherwise . The default value is , /// i.e. not to try to reconnect. /// /// @@ -317,7 +317,7 @@ public AdoNetAppender() /// /// /// To force the appender to attempt to reconnect to the database set this - /// property to true. + /// property to . /// /// /// When the appender attempts to connect to the database there may be a @@ -458,7 +458,7 @@ protected override void SendBuffer(LoggingEvent[] events) /// The array of events to insert into the database. /// /// - /// The transaction argument can be null if the appender has been + /// The transaction argument can be if the appender has been /// configured not to use transactions. See /// property for more information. /// diff --git a/src/log4net/Appender/AppenderSkeleton.cs b/src/log4net/Appender/AppenderSkeleton.cs index 474bac42..5e0052c2 100644 --- a/src/log4net/Appender/AppenderSkeleton.cs +++ b/src/log4net/Appender/AppenderSkeleton.cs @@ -59,7 +59,7 @@ public abstract class AppenderSkeleton : IAppender, IBulkAppender, IOptionHandle /// /// /// - /// If this appender has not been closed then the Finalize method + /// If this appender has not been closed then the method /// will call . /// /// @@ -236,7 +236,7 @@ public void Close() /// /// /// Calls and checks that - /// it returns true. + /// it returns . /// /// /// @@ -318,7 +318,7 @@ public void DoAppend(LoggingEvent loggingEvent) /// /// /// Calls and checks that - /// it returns true. + /// it returns . /// /// /// @@ -383,7 +383,7 @@ public void DoAppend(LoggingEvent[] loggingEvents) /// Test if the logging event should we output by this appender /// /// the event to test - /// true if the event should be output, false if the event should be ignored + /// if the event should be output, if the event should be ignored /// /// /// This method checks the logging event against the threshold level set @@ -482,8 +482,8 @@ public virtual void AddFilter(IFilter filter) /// /// to test against. /// - /// true if the meets the - /// requirements of this appender. A null level always maps to true, + /// if the meets the + /// requirements of this appender. A null level always maps to , /// the equivalent of . /// protected virtual bool IsAsSevereAsThreshold(Level? level) => level is null || level >= Threshold; @@ -587,7 +587,7 @@ protected virtual void Append(IEnumerable loggingEvents) /// this base class if it is overridden. /// /// - /// true if the call to should proceed. + /// if the call to should proceed. protected virtual bool PreAppendCheck() { if ((Layout is null) && RequiresLayout) @@ -698,14 +698,14 @@ protected void RenderLoggingEvent(TextWriter writer, LoggingEvent loggingEvent) /// /// In the rather exceptional case, where the appender /// implementation admits a layout but can also work without it, - /// then the appender should return true. + /// then the appender should return . /// /// - /// This default implementation always returns false. + /// This default implementation always returns . /// /// /// - /// true if the appender requires a layout object, otherwise false. + /// if the appender requires a layout object, otherwise . /// protected virtual bool RequiresLayout => false; @@ -715,7 +715,7 @@ protected void RenderLoggingEvent(TextWriter writer, LoggingEvent loggingEvent) /// /// This implementation doesn't flush anything and always returns true /// - /// True if all logging events were flushed successfully, else false. + /// if all logging events were flushed successfully, else . public virtual bool Flush(int millisecondsTimeout) => true; /// diff --git a/src/log4net/Appender/BufferingAppenderSkeleton.cs b/src/log4net/Appender/BufferingAppenderSkeleton.cs index c4b2ad8c..31fff5b9 100644 --- a/src/log4net/Appender/BufferingAppenderSkeleton.cs +++ b/src/log4net/Appender/BufferingAppenderSkeleton.cs @@ -56,7 +56,7 @@ namespace log4net.Appender; /// The buffering appender can be configured in a mode. /// By default the appender is NOT lossy. When the buffer is full all /// the buffered events are sent with . -/// If the property is set to true then the +/// If the property is set to then the /// buffer will not be sent when it is full, and new events arriving /// in the appender will overwrite the oldest event in the buffer. /// In lossy mode the buffer will only be sent when the @@ -87,7 +87,7 @@ protected BufferingAppenderSkeleton() : this(true) /// Initializes a new instance of the class. /// /// the events passed through this appender must be - /// fixed by the time that they arrive in the derived class' SendBuffer method. + /// fixed by the time that they arrive in the derived class' method. /// /// /// Protected constructor to allow subclassing. @@ -107,7 +107,7 @@ protected BufferingAppenderSkeleton(bool eventMustBeFixed) /// Gets or sets a value that indicates whether the appender is lossy. /// /// - /// true if the appender is lossy, otherwise false. The default is false. + /// if the appender is lossy, otherwise . The default is . /// /// /// @@ -115,10 +115,10 @@ protected BufferingAppenderSkeleton(bool eventMustBeFixed) /// delivering them. A triggering event causes the whole buffer /// to be sent to the remote sink. If the buffer overruns before /// a triggering event then logging events could be lost. Set - /// to false to prevent logging events + /// to to prevent logging events /// from being lost. /// - /// If is set to true then an + /// If is set to then an /// must be specified. /// public bool Lossy { get; set; } @@ -162,7 +162,7 @@ protected BufferingAppenderSkeleton(bool eventMustBeFixed) /// appender. If the evaluator triggers then the current buffer will /// immediately be sent (see ). /// - /// If is set to true then an + /// If is set to then an /// must be specified. /// public ITriggeringEventEvaluator? Evaluator { get; set; } @@ -202,7 +202,7 @@ protected BufferingAppenderSkeleton(bool eventMustBeFixed) /// Flushes any buffered log data. /// /// The maximum time to wait for logging events to be flushed. - /// True if all logging events were flushed successfully, else false. + /// if all logging events were flushed successfully, else . public override bool Flush(int millisecondsTimeout) { Flush(); @@ -226,21 +226,21 @@ public override bool Flush(int millisecondsTimeout) /// /// Flush the currently buffered events /// - /// set to true to flush the buffer of lossy events + /// set to to flush the buffer of lossy events /// /// /// Flushes events that have been buffered. If is - /// false then events will only be flushed if this buffer is non-lossy mode. + /// then events will only be flushed if this buffer is non-lossy mode. /// /// /// If the appender is buffering in mode then the contents - /// of the buffer will only be flushed if is true. + /// of the buffer will only be flushed if is . /// In this case the contents of the buffer will be tested against the /// and if triggering will be output. All other buffered /// events will be discarded. /// /// - /// If is true then the buffer will always + /// If is then the buffer will always /// be emptied by calling this method. /// /// @@ -262,7 +262,7 @@ public virtual void Flush(bool flushLossyBuffer) { // Test the contents of the buffer against the lossy evaluator LoggingEvent[] bufferedEvents = _cyclicBuffer.PopAll(); - var filteredEvents = new List(bufferedEvents.Length); + List filteredEvents = new(bufferedEvents.Length); foreach (LoggingEvent loggingEvent in bufferedEvents) { diff --git a/src/log4net/Appender/BufferingForwardingAppender.cs b/src/log4net/Appender/BufferingForwardingAppender.cs index 324f4e9a..47ca516b 100644 --- a/src/log4net/Appender/BufferingForwardingAppender.cs +++ b/src/log4net/Appender/BufferingForwardingAppender.cs @@ -138,7 +138,7 @@ public virtual AppenderCollection Appenders /// /// The name of the appender to lookup. /// - /// The appender with the specified name, or null. + /// The appender with the specified name, or . /// public virtual IAppender? GetAppender(string? name) { diff --git a/src/log4net/Appender/DebugAppender.cs b/src/log4net/Appender/DebugAppender.cs index caf45348..41bcbc73 100644 --- a/src/log4net/Appender/DebugAppender.cs +++ b/src/log4net/Appender/DebugAppender.cs @@ -48,7 +48,7 @@ public class DebugAppender : AppenderSkeleton /// /// /// The default behavior is to flush at the end of each - /// write. If the option is set tofalse, then the underlying + /// write. If the option is set to, then the underlying /// stream can defer writing to physical medium to a later time. /// /// @@ -77,7 +77,7 @@ public class DebugAppender : AppenderSkeleton /// Flushes any buffered log data. /// /// The maximum time to wait for logging events to be flushed. - /// True if all logging events were flushed successfully, else false. + /// if all logging events were flushed successfully, else . public override bool Flush(int millisecondsTimeout) { // Nothing to do if ImmediateFlush is true @@ -99,7 +99,7 @@ public override bool Flush(int millisecondsTimeout) /// /// /// Writes the logging event to the system. - /// If is true then the + /// If is then the /// is called. /// /// diff --git a/src/log4net/Appender/EventLogAppender.cs b/src/log4net/Appender/EventLogAppender.cs index 8a8bfa8c..a8e66c04 100644 --- a/src/log4net/Appender/EventLogAppender.cs +++ b/src/log4net/Appender/EventLogAppender.cs @@ -42,8 +42,8 @@ namespace log4net.Appender; /// on the . /// /// -/// The Category of the event log entry can be -/// set using the Category property () +/// The of the event log entry can be +/// set using the property () /// on the . /// /// @@ -174,7 +174,7 @@ public EventLogAppender() public SecurityContext? SecurityContext { get; set; } /// - /// Gets or sets the EventId to use unless one is explicitly specified via the LoggingEvent's properties. + /// Gets or sets the to use unless one is explicitly specified via the LoggingEvent's properties. /// /// /// @@ -188,12 +188,12 @@ public EventLogAppender() /// - /// Gets or sets the Category to use unless one is explicitly specified via the LoggingEvent's properties. + /// Gets or sets the to use unless one is explicitly specified via the LoggingEvent's properties. /// /// /// - /// The Category of the event log entry will normally be - /// set using the Category property () + /// The of the event log entry will normally be + /// set using the property () /// on the . /// This property provides the fallback value which defaults to 0. /// @@ -287,7 +287,7 @@ public override void ActivateOptions() /// private static void CreateEventSource(string source, string logName, string machineName) { - var eventSourceCreationData = new EventSourceCreationData(source, logName) + EventSourceCreationData eventSourceCreationData = new(source, logName) { MachineName = machineName }; @@ -402,7 +402,7 @@ protected override void Append(LoggingEvent loggingEvent) /// /// This appender requires a to be set. /// - /// true + /// protected override bool RequiresLayout => true; /// diff --git a/src/log4net/Appender/ForwardingAppender.cs b/src/log4net/Appender/ForwardingAppender.cs index 609a65d9..ed0f485f 100644 --- a/src/log4net/Appender/ForwardingAppender.cs +++ b/src/log4net/Appender/ForwardingAppender.cs @@ -128,7 +128,7 @@ public virtual AppenderCollection Appenders /// /// The name of the appender to lookup. /// - /// The appender with the specified name, or null. + /// The appender with the specified name, or . /// /// /// diff --git a/src/log4net/Appender/IFlushable.cs b/src/log4net/Appender/IFlushable.cs index 0952a8d1..ac2c5de3 100644 --- a/src/log4net/Appender/IFlushable.cs +++ b/src/log4net/Appender/IFlushable.cs @@ -51,6 +51,6 @@ public interface IFlushable /// /// /// The maximum time to wait for logging events to be flushed. - /// True if all logging events were flushed successfully, else false. + /// if all logging events were flushed successfully, else . bool Flush(int millisecondsTimeout); } \ No newline at end of file diff --git a/src/log4net/Appender/RollingFileAppender.cs b/src/log4net/Appender/RollingFileAppender.cs index 5e983df3..55b30078 100644 --- a/src/log4net/Appender/RollingFileAppender.cs +++ b/src/log4net/Appender/RollingFileAppender.cs @@ -1238,7 +1238,7 @@ protected void DeleteFile(string fileName) /// If countDirection < 0, then files /// {File.1, ..., File.curSizeRollBackups -1} /// are renamed to {File.2, ..., - /// File.curSizeRollBackups}. Moreover, File is + /// File.curSizeRollBackups}. Moreover, is /// renamed File.1 and closed. /// /// @@ -1246,10 +1246,10 @@ protected void DeleteFile(string fileName) /// /// /// If maxSizeRollBackups is equal to zero, then the - /// File is truncated with no backup files created. + /// is truncated with no backup files created. /// /// - /// If maxSizeRollBackups < 0, then File is + /// If maxSizeRollBackups < 0, then is /// renamed if needed and no files are deleted. /// /// @@ -1292,10 +1292,10 @@ protected void RollOverSize() /// /// /// If maxSizeRollBackups is equal to zero, then the - /// File is truncated with no backup files created. + /// is truncated with no backup files created. /// /// - /// If maxSizeRollBackups < 0, then File is + /// If maxSizeRollBackups < 0, then is /// renamed if needed and no files are deleted. /// /// diff --git a/src/log4net/Appender/SmtpAppender.cs b/src/log4net/Appender/SmtpAppender.cs index 1b56b662..77683ef9 100644 --- a/src/log4net/Appender/SmtpAppender.cs +++ b/src/log4net/Appender/SmtpAppender.cs @@ -254,7 +254,7 @@ protected override void SendBuffer(LoggingEvent[] events) // appender. This frees us from needing to synchronize again. try { - using var writer = new StringWriter(System.Globalization.CultureInfo.InvariantCulture); + using StringWriter writer = new(System.Globalization.CultureInfo.InvariantCulture); if (Layout?.Header is string header) { @@ -314,7 +314,7 @@ protected virtual void SendEmail(string messageBody) smtpClient.Credentials = System.Net.CredentialCache.DefaultNetworkCredentials; } - using var mailMessage = new MailMessage(); + using MailMessage mailMessage = new(); mailMessage.Body = messageBody; mailMessage.BodyEncoding = BodyEncoding; mailMessage.From = new MailAddress(From.EnsureNotNull()); diff --git a/src/log4net/Appender/TextWriterAppender.cs b/src/log4net/Appender/TextWriterAppender.cs index e4d58ec4..3321b152 100644 --- a/src/log4net/Appender/TextWriterAppender.cs +++ b/src/log4net/Appender/TextWriterAppender.cs @@ -54,7 +54,7 @@ public class TextWriterAppender : AppenderSkeleton /// append operation. /// /// - /// If this option is set to false, then the underlying + /// If this option is set to , then the underlying /// stream can defer persisting the logging event to a later /// time. /// @@ -110,7 +110,7 @@ public virtual TextWriter? Writer /// layout has been set. /// /// - /// false if any of the preconditions fail. + /// if any of the preconditions fail. protected override bool PreAppendCheck() { if (!base.PreAppendCheck()) @@ -372,7 +372,7 @@ protected virtual void PrepareWriter() /// Flushes any buffered log data. /// /// The maximum time to wait for logging events to be flushed. - /// True if all logging events were flushed successfully, else false. + /// if all logging events were flushed successfully, else . public override bool Flush(int millisecondsTimeout) { // Nothing to do if ImmediateFlush is true diff --git a/src/log4net/Appender/TraceAppender.cs b/src/log4net/Appender/TraceAppender.cs index f025795d..919da3ae 100644 --- a/src/log4net/Appender/TraceAppender.cs +++ b/src/log4net/Appender/TraceAppender.cs @@ -59,7 +59,7 @@ public class TraceAppender : AppenderSkeleton /// /// /// The default behavior is to flush at the end of each - /// write. If the option is set tofalse, then the underlying + /// write. If the option is set to, then the underlying /// stream can defer writing to physical medium to a later time. /// /// @@ -107,7 +107,7 @@ protected override void Append(LoggingEvent loggingEvent) /// Flushes any buffered log data. /// /// The maximum time to wait for logging events to be flushed. - /// True if all logging events were flushed successfully, else false. + /// if all logging events were flushed successfully, else . public override bool Flush(int millisecondsTimeout) { // Nothing to do if ImmediateFlush is true diff --git a/src/log4net/Config/XmlConfiguratorAttribute.cs b/src/log4net/Config/XmlConfiguratorAttribute.cs index 0bf39053..0f3af574 100644 --- a/src/log4net/Config/XmlConfiguratorAttribute.cs +++ b/src/log4net/Config/XmlConfiguratorAttribute.cs @@ -134,11 +134,11 @@ public XmlConfiguratorAttribute() : base(0) /* configurator priority 0 */ /// Gets or sets a value indicating whether to watch the configuration file. /// /// - /// true if the configuration should be watched, false otherwise. + /// if the configuration should be watched, otherwise. /// /// /// - /// If this flag is specified and set to true then the framework + /// If this flag is specified and set to then the framework /// will watch the configuration file and will reload the config each time /// the file is modified. /// @@ -170,7 +170,7 @@ public XmlConfiguratorAttribute() : base(0) /* configurator priority 0 */ /// The does not extend . public override void Configure(Assembly sourceAssembly, ILoggerRepository targetRepository) { - var configurationMessages = new List(); + List configurationMessages = new(); using (new LogLog.LogReceivedAdapter(configurationMessages)) { @@ -344,7 +344,7 @@ private void ConfigureFromUri(ILoggerRepository targetRepository) if (systemConfigFilePath is not null) { - var builder = new UriBuilder(new Uri(systemConfigFilePath)); + UriBuilder builder = new(new Uri(systemConfigFilePath)); // Remove the current extension from the systemConfigFileUri path string path = builder.Path; diff --git a/src/log4net/Core/DefaultRepositorySelector.cs b/src/log4net/Core/DefaultRepositorySelector.cs index 4cc14c88..a14d6c82 100644 --- a/src/log4net/Core/DefaultRepositorySelector.cs +++ b/src/log4net/Core/DefaultRepositorySelector.cs @@ -117,7 +117,7 @@ public ILoggerRepository GetRepository(Assembly assembly) /// The for the specified repository. /// /// - /// Returns the named repository. If is null + /// Returns the named repository. If is /// a is thrown. If the repository /// does not exist a is thrown. /// @@ -184,7 +184,7 @@ public ILoggerRepository CreateRepository(Assembly assembly, Type repositoryType /// the assembly to use to create the repository to associate with the . /// The type of repository to create, must implement . /// The name to assign to the created repository - /// Set to true to read and apply the assembly attributes + /// Set to to read and apply the assembly attributes /// The repository created. /// /// @@ -372,7 +372,7 @@ public ILoggerRepository CreateRepository(string repositoryName, Type? repositor /// Test if a named repository exists /// /// the named repository to check - /// true if the repository exists + /// if the repository exists /// /// /// Test if a named repository exists. Use diff --git a/src/log4net/Core/ExceptionEvaluator.cs b/src/log4net/Core/ExceptionEvaluator.cs index 5fd50882..afdc9988 100644 --- a/src/log4net/Core/ExceptionEvaluator.cs +++ b/src/log4net/Core/ExceptionEvaluator.cs @@ -68,9 +68,9 @@ public ExceptionEvaluator(Type exType, bool triggerOnSubClass) /// Is this the triggering event? /// /// The event to check - /// This method returns true, if the logging event Exception + /// This method returns , if the logging event Exception /// Type is . - /// Otherwise it returns false + /// Otherwise it returns /// /// /// This evaluator will trigger if the Exception Type of the event diff --git a/src/log4net/Core/IAppenderAttachable.cs b/src/log4net/Core/IAppenderAttachable.cs index 241318e7..acdf866f 100644 --- a/src/log4net/Core/IAppenderAttachable.cs +++ b/src/log4net/Core/IAppenderAttachable.cs @@ -56,7 +56,7 @@ public interface IAppenderAttachable /// Gets a collection of attached appenders. /// If there are no attached appenders the /// implementation should return an empty - /// collection rather than null. + /// collection rather than . /// /// AppenderCollection Appenders { get; } @@ -66,13 +66,13 @@ public interface IAppenderAttachable /// /// The name of the appender to get. /// - /// The appender with the name specified, or null if no appender with the + /// The appender with the name specified, or if no appender with the /// specified name is found. /// /// /// /// Returns an attached appender with the specified. - /// If no appender with the specified name is found null will be + /// If no appender with the specified name is found will be /// returned. /// /// diff --git a/src/log4net/Core/ILogger.cs b/src/log4net/Core/ILogger.cs index 21272a69..ebf36867 100644 --- a/src/log4net/Core/ILogger.cs +++ b/src/log4net/Core/ILogger.cs @@ -51,7 +51,7 @@ public interface ILogger /// the stack boundary into the logging system for this call. /// The level of the message to be logged. /// The message object to log. - /// the exception to log, including its stack trace. Pass null to not log an exception. + /// the exception to log, including its stack trace. Pass to not log an exception. /// /// /// This generic form is intended to be used by wrappers. @@ -76,7 +76,7 @@ public interface ILogger /// /// The level to check. /// - /// true if this logger is enabled for level, otherwise false. + /// if this logger is enabled for level, otherwise . /// bool IsEnabledFor(Level? level); diff --git a/src/log4net/Core/IRepositorySelector.cs b/src/log4net/Core/IRepositorySelector.cs index d5ff2cad..2ac3d52d 100644 --- a/src/log4net/Core/IRepositorySelector.cs +++ b/src/log4net/Core/IRepositorySelector.cs @@ -148,7 +148,7 @@ public interface IRepositorySelector /// Test if a named repository exists /// /// the named repository to check - /// true if the repository exists + /// if the repository exists /// /// /// Test if a named repository exists. Use diff --git a/src/log4net/Core/ITriggeringEventEvaluator.cs b/src/log4net/Core/ITriggeringEventEvaluator.cs index 9321c26b..6f052ab1 100644 --- a/src/log4net/Core/ITriggeringEventEvaluator.cs +++ b/src/log4net/Core/ITriggeringEventEvaluator.cs @@ -38,10 +38,10 @@ public interface ITriggeringEventEvaluator /// Test if this event triggers the action /// /// The event to check - /// true if this event triggers the action, otherwise false + /// if this event triggers the action, otherwise /// /// - /// Return true if this event triggers the action + /// Return if this event triggers the action /// /// bool IsTriggeringEvent(LoggingEvent loggingEvent); diff --git a/src/log4net/Core/LevelCollection.cs b/src/log4net/Core/LevelCollection.cs index 9196d50b..e666d256 100644 --- a/src/log4net/Core/LevelCollection.cs +++ b/src/log4net/Core/LevelCollection.cs @@ -44,8 +44,8 @@ public interface ILevelCollectionEnumerator /// Advances the enumerator to the next element in the collection. /// /// - /// true if the enumerator was successfully advanced to the next element; - /// false if the enumerator has passed the end of the collection. + /// if the enumerator was successfully advanced to the next element; + /// if the enumerator has passed the end of the collection. /// /// /// The collection was modified after the enumerator was created. @@ -64,35 +64,35 @@ public interface ILevelCollectionEnumerator private int _version; /// - /// Creates a read-only wrapper for a LevelCollection instance. + /// Creates a read-only wrapper for a instance. /// /// list to create a readonly wrapper arround /// - /// A LevelCollection wrapper that is read-only. + /// A wrapper that is read-only. /// public static LevelCollection ReadOnly(LevelCollection list) => new ReadOnlyLevelCollection(list.EnsureNotNull()); /// - /// Initializes a new instance of the LevelCollection class + /// Initializes a new instance of the class /// that is empty and has the default initial capacity. /// public LevelCollection() => _array = new Level[DefaultCapacity]; /// - /// Initializes a new instance of the LevelCollection class + /// Initializes a new instance of the class /// that has the specified initial capacity. /// /// - /// The number of elements that the new LevelCollection is initially capable of storing. + /// The number of elements that the new is initially capable of storing. /// public LevelCollection(int capacity) => _array = new Level[capacity]; /// - /// Initializes a new instance of the LevelCollection class - /// that contains elements copied from the specified LevelCollection. + /// Initializes a new instance of the class + /// that contains elements copied from the specified . /// - /// The LevelCollection whose elements are copied to the new collection. + /// The whose elements are copied to the new collection. [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2214:Do not call overridable methods in constructors")] public LevelCollection(LevelCollection collection) { @@ -101,7 +101,7 @@ public LevelCollection(LevelCollection collection) } /// - /// Initializes a new instance of the LevelCollection class + /// Initializes a new instance of the class /// that contains elements copied from the specified array. /// /// The array whose elements are copied to the new list. @@ -113,7 +113,7 @@ public LevelCollection(Level[] array) } /// - /// Initializes a new instance of the LevelCollection class + /// Initializes a new instance of the class /// that contains elements copied from the specified collection. /// /// The collection whose elements are copied to the new list. @@ -125,7 +125,7 @@ public LevelCollection(ICollection collection) } /// - /// Initializes a new instance of the LevelCollection class + /// Initializes a new instance of the class /// that contains elements copied from the specified collection. /// /// The collection whose elements are copied to the new list. @@ -154,19 +154,19 @@ protected internal enum Tag protected internal LevelCollection(Tag _) => _array = Array.Empty(); /// - /// Gets the number of elements actually contained in the LevelCollection. + /// Gets the number of elements actually contained in the . /// public virtual int Count { get; private set; } /// - /// Copies the entire LevelCollection to a one-dimensional + /// Copies the entire to a one-dimensional /// array. /// /// The one-dimensional array to copy to. public virtual void CopyTo(Level[] array) => CopyTo(array, 0); /// - /// Copies the entire LevelCollection to a one-dimensional + /// Copies the entire to a one-dimensional /// array, starting at the specified index of the target array. /// /// The one-dimensional array to copy to. @@ -217,9 +217,9 @@ public virtual Level this[int index] } /// - /// Adds a to the end of the LevelCollection. + /// Adds a to the end of the . /// - /// The to be added to the end of the LevelCollection. + /// The to be added to the end of the . /// The index at which the value has been added. public virtual int Add(Level item) { @@ -235,7 +235,7 @@ public virtual int Add(Level item) } /// - /// Removes all elements from the LevelCollection. + /// Removes all elements from the . /// public virtual void Clear() { @@ -250,7 +250,7 @@ public virtual void Clear() /// A new with a shallow copy of the collection data. public virtual object Clone() { - var newCol = new LevelCollection(Count); + LevelCollection newCol = new(Count); Array.Copy(_array, 0, newCol._array, 0, Count); newCol.Count = Count; newCol._version = _version; @@ -259,10 +259,10 @@ public virtual object Clone() } /// - /// Determines whether a given is in the LevelCollection. + /// Determines whether a given is in the . /// /// The to check for. - /// true if is found in the LevelCollection; otherwise, false. + /// if is found in the ; otherwise, . public virtual bool Contains(Level item) { for (int i = 0; i != Count; ++i) @@ -277,12 +277,12 @@ public virtual bool Contains(Level item) /// /// Returns the zero-based index of the first occurrence of a - /// in the LevelCollection. + /// in the . /// - /// The to locate in the LevelCollection. + /// The to locate in the . /// /// The zero-based index of the first occurrence of - /// in the entire LevelCollection, if found; otherwise, -1. + /// in the entire , if found; otherwise, -1. /// public virtual int IndexOf(Level item) { @@ -297,7 +297,7 @@ public virtual int IndexOf(Level item) } /// - /// Inserts an element into the LevelCollection at the specified index. + /// Inserts an element into the at the specified index. /// /// The zero-based index at which should be inserted. /// The to insert. @@ -326,11 +326,11 @@ public virtual void Insert(int index, Level item) } /// - /// Removes the first occurrence of a specific from the LevelCollection. + /// Removes the first occurrence of a specific from the . /// - /// The to remove from the LevelCollection. + /// The to remove from the . /// - /// The specified was not found in the LevelCollection. + /// The specified was not found in the . /// public virtual void Remove(Level item) { @@ -345,7 +345,7 @@ public virtual void Remove(Level item) } /// - /// Removes the element at the specified index of the LevelCollection. + /// Removes the element at the specified index of the . /// /// The zero-based index of the element to remove. /// @@ -385,13 +385,13 @@ public virtual void RemoveAt(int index) public virtual bool IsReadOnly => false; /// - /// Returns an enumerator that can iterate through the LevelCollection. + /// Returns an enumerator that can iterate through the . /// - /// An for the entire LevelCollection. + /// An for the entire . public virtual ILevelCollectionEnumerator GetEnumerator() => new Enumerator(this); /// - /// Gets or sets the number of elements the LevelCollection can contain. + /// Gets or sets the number of elements the can contain. /// public virtual int Capacity { @@ -420,10 +420,10 @@ public virtual int Capacity } /// - /// Adds the elements of another LevelCollection to the current LevelCollection. + /// Adds the elements of another to the current . /// - /// The LevelCollection whose elements should be added to the end of the current LevelCollection. - /// The new of the LevelCollection. + /// The whose elements should be added to the end of the current . + /// The new of the . public virtual int AddRange(LevelCollection collection) { if (Count + collection.EnsureNotNull().Count >= _array.Length) @@ -439,10 +439,10 @@ public virtual int AddRange(LevelCollection collection) } /// - /// Adds the elements of a array to the current LevelCollection. + /// Adds the elements of a array to the current . /// - /// The array whose elements should be added to the end of the LevelCollection. - /// The new of the LevelCollection. + /// The array whose elements should be added to the end of the . + /// The new of the . public virtual int AddRange(Level[] array) { if (Count + array.EnsureNotNull().Length >= _array.Length) @@ -458,10 +458,10 @@ public virtual int AddRange(Level[] array) } /// - /// Adds the elements of a collection to the current LevelCollection. + /// Adds the elements of a collection to the current . /// - /// The collection whose elements should be added to the end of the LevelCollection. - /// The new of the LevelCollection. + /// The collection whose elements should be added to the end of the . + /// The new of the . public virtual int AddRange(ICollection collection) { if (Count + collection.EnsureNotNull().Count >= _array.Length) @@ -547,7 +547,7 @@ private sealed class Enumerator : IEnumerator, ILevelCollectionEnumerator private readonly int _version; /// - /// Initializes a new instance of the Enumerator class. + /// Initializes a new instance of the class. /// /// internal Enumerator(LevelCollection tc) @@ -566,8 +566,8 @@ internal Enumerator(LevelCollection tc) /// Advances the enumerator to the next element in the collection. /// /// - /// true if the enumerator was successfully advanced to the next element; - /// false if the enumerator has passed the end of the collection. + /// if the enumerator was successfully advanced to the next element; + /// if the enumerator has passed the end of the collection. /// /// /// The collection was modified after the enumerator was created. diff --git a/src/log4net/Core/LevelEvaluator.cs b/src/log4net/Core/LevelEvaluator.cs index da056ff5..5be88665 100644 --- a/src/log4net/Core/LevelEvaluator.cs +++ b/src/log4net/Core/LevelEvaluator.cs @@ -71,9 +71,9 @@ public LevelEvaluator() /// Is this the triggering event? /// /// The event to check - /// This method returns true, if the event level + /// This method returns , if the event level /// is equal or higher than the . - /// Otherwise it returns false + /// Otherwise it returns public bool IsTriggeringEvent(LoggingEvent loggingEvent) => loggingEvent.EnsureNotNull().Level is null || loggingEvent.Level >= Threshold; } diff --git a/src/log4net/Core/LevelMap.cs b/src/log4net/Core/LevelMap.cs index 485af58c..a72c7e04 100644 --- a/src/log4net/Core/LevelMap.cs +++ b/src/log4net/Core/LevelMap.cs @@ -57,7 +57,7 @@ public void Clear() => /// Looks up a by name /// /// The name of the Level to look up. - /// A Level from the map with the name specified, or null if none is found. + /// A Level from the map with the name specified, or if none is found. public Level? this[string name] { get diff --git a/src/log4net/Core/LocationInfo.cs b/src/log4net/Core/LocationInfo.cs index 0d30baaf..963797f1 100644 --- a/src/log4net/Core/LocationInfo.cs +++ b/src/log4net/Core/LocationInfo.cs @@ -113,7 +113,7 @@ public LocationInfo(Type? callerStackBoundaryDeclaringType) { // take into account the frames we skip above int adjustedFrameCount = st.FrameCount - frameIndex; - var stackFramesList = new List(adjustedFrameCount); + List stackFramesList = new(adjustedFrameCount); StackFrames = new StackFrameItem[adjustedFrameCount]; for (int i = frameIndex; i < st.FrameCount; i++) { diff --git a/src/log4net/Core/LogImpl.cs b/src/log4net/Core/LogImpl.cs index aafc32d5..383c1948 100644 --- a/src/log4net/Core/LogImpl.cs +++ b/src/log4net/Core/LogImpl.cs @@ -1142,8 +1142,8 @@ public virtual void FatalFormat(IFormatProvider? provider, string format, params /// level. /// /// - /// true if this logger is enabled for DEBUG events, - /// false otherwise. + /// if this logger is enabled for DEBUG events, + /// otherwise. /// /// /// @@ -1174,8 +1174,8 @@ public virtual void FatalFormat(IFormatProvider? provider, string format, params /// construction if debugging is disabled for log. On /// the other hand, if the log is debug enabled, you /// will incur the cost of evaluating whether the logger is debug - /// enabled twice. Once in IsDebugEnabled and once in - /// the Debug. This is an insignificant overhead + /// enabled twice. Once in and once in + /// the . This is an insignificant overhead /// since evaluating a logger takes about 1% of the time it /// takes to actually log. /// @@ -1186,8 +1186,8 @@ public virtual void FatalFormat(IFormatProvider? provider, string format, params /// Checks if this logger is enabled for the INFO level. /// /// - /// true if this logger is enabled for INFO events, - /// false otherwise. + /// if this logger is enabled for INFO events, + /// otherwise. /// /// /// @@ -1202,8 +1202,8 @@ public virtual void FatalFormat(IFormatProvider? provider, string format, params /// Checks if this logger is enabled for the WARN level. /// /// - /// true if this logger is enabled for WARN events, - /// false otherwise. + /// if this logger is enabled for WARN events, + /// otherwise. /// /// /// @@ -1218,8 +1218,8 @@ public virtual void FatalFormat(IFormatProvider? provider, string format, params /// Checks if this logger is enabled for the ERROR level. /// /// - /// true if this logger is enabled for ERROR events, - /// false otherwise. + /// if this logger is enabled for ERROR events, + /// otherwise. /// /// /// @@ -1233,8 +1233,8 @@ public virtual void FatalFormat(IFormatProvider? provider, string format, params /// Checks if this logger is enabled for the FATAL level. /// /// - /// true if this logger is enabled for FATAL events, - /// false otherwise. + /// if this logger is enabled for FATAL events, + /// otherwise. /// /// /// diff --git a/src/log4net/Core/LoggerManager.cs b/src/log4net/Core/LoggerManager.cs index ab6fb89b..8e6917f3 100644 --- a/src/log4net/Core/LoggerManager.cs +++ b/src/log4net/Core/LoggerManager.cs @@ -175,14 +175,14 @@ public static ILoggerRepository GetRepository(Assembly repositoryAssembly) /// The repository to lookup in. /// The fully qualified logger name to look for. /// - /// The logger found, or null if the named logger does not exist in the + /// The logger found, or if the named logger does not exist in the /// specified repository. /// /// /// /// If the named logger exists (in the specified repository) then it /// returns a reference to the logger, otherwise it returns - /// null. + /// . /// /// public static ILogger? Exists(string repository, string name) @@ -194,14 +194,14 @@ public static ILoggerRepository GetRepository(Assembly repositoryAssembly) /// The assembly to use to look up the repository. /// The fully qualified logger name to look for. /// - /// The logger found, or null if the named logger does not exist in the + /// The logger found, or if the named logger does not exist in the /// specified assembly's repository. /// /// /// /// If the named logger exists (in the specified assembly's repository) then it /// returns a reference to the logger, otherwise it returns - /// null. + /// . /// /// public static ILogger? Exists(Assembly repositoryAssembly, string name) @@ -406,8 +406,8 @@ public static void ShutdownRepository(Assembly repositoryAssembly) /// /// Resets all values contained in the repository instance to their /// defaults. This removes all appenders from all loggers, sets - /// the level of all non-root loggers to null, - /// sets their additivity flag to true and sets the level + /// the level of all non-root loggers to , + /// sets their additivity flag to and sets the level /// of the root logger to . Moreover, /// message disabling is set its default "off" value. /// @@ -423,8 +423,8 @@ public static void ResetConfiguration(string repository) /// /// Resets all values contained in the repository instance to their /// defaults. This removes all appenders from all loggers, sets - /// the level of all non-root loggers to null, - /// sets their additivity flag to true and sets the level + /// the level of all non-root loggers to , + /// sets their additivity flag to and sets the level /// of the root logger to . Moreover, /// message disabling is set its default "off" value. /// diff --git a/src/log4net/Core/LoggerWrapperImpl.cs b/src/log4net/Core/LoggerWrapperImpl.cs index d502c33d..d51e960a 100644 --- a/src/log4net/Core/LoggerWrapperImpl.cs +++ b/src/log4net/Core/LoggerWrapperImpl.cs @@ -41,7 +41,7 @@ public abstract class LoggerWrapperImpl(ILogger logger) : ILoggerWrapper /// /// /// - /// The Logger object may not be the same object as this object + /// The object may not be the same object as this object /// because of logger decorators. /// /// diff --git a/src/log4net/Core/SecurityContext.cs b/src/log4net/Core/SecurityContext.cs index 3c6095c0..69010e1a 100644 --- a/src/log4net/Core/SecurityContext.cs +++ b/src/log4net/Core/SecurityContext.cs @@ -39,7 +39,7 @@ public abstract class SecurityContext /// /// State supplied by the caller /// An instance that will - /// revoke the impersonation of this SecurityContext, or null + /// revoke the impersonation of this SecurityContext, or /// /// /// Impersonate this security context. Further calls on the current diff --git a/src/log4net/Core/TimeEvaluator.cs b/src/log4net/Core/TimeEvaluator.cs index e6672f4d..a050f257 100644 --- a/src/log4net/Core/TimeEvaluator.cs +++ b/src/log4net/Core/TimeEvaluator.cs @@ -84,9 +84,9 @@ public TimeEvaluator() /// Is this the triggering event? /// /// The event to check - /// This method returns true, if the specified time period + /// This method returns , if the specified time period /// has passed since last check.. - /// Otherwise it returns false + /// Otherwise it returns /// /// /// This evaluator will trigger if the specified time period diff --git a/src/log4net/Filter/FilterSkeleton.cs b/src/log4net/Filter/FilterSkeleton.cs index 7b4c5ffb..e6a9e27d 100644 --- a/src/log4net/Filter/FilterSkeleton.cs +++ b/src/log4net/Filter/FilterSkeleton.cs @@ -105,7 +105,7 @@ public virtual void ActivateOptions() /// the chain. /// /// - /// This method is marked abstract and must be implemented + /// This method is marked and must be implemented /// in a subclass. /// /// diff --git a/src/log4net/Filter/LevelMatchFilter.cs b/src/log4net/Filter/LevelMatchFilter.cs index 71769cdc..80b3eb0b 100644 --- a/src/log4net/Filter/LevelMatchFilter.cs +++ b/src/log4net/Filter/LevelMatchFilter.cs @@ -34,7 +34,7 @@ namespace log4net.Filter; /// of the option and the of the /// , then the method returns in /// case the option value is set -/// to true, if it is false then +/// to , if it is then /// is returned. If the does not match then /// the result will be . /// @@ -54,7 +54,7 @@ public class LevelMatchFilter : FilterSkeleton /// logging event, otherwise it will the event. /// /// - /// The default is true i.e. to the event. + /// The default is i.e. to the event. /// /// public bool AcceptOnMatch { get; set; } = true; diff --git a/src/log4net/Filter/LevelRangeFilter.cs b/src/log4net/Filter/LevelRangeFilter.cs index de6b9eb2..dc3104a3 100644 --- a/src/log4net/Filter/LevelRangeFilter.cs +++ b/src/log4net/Filter/LevelRangeFilter.cs @@ -34,7 +34,7 @@ namespace log4net.Filter; /// . If there is a match between the range /// of priorities and the of the , then the /// method returns in case the -/// option value is set to true, if it is false +/// option value is set to , if it is /// then is returned. If there is no match, is returned. /// /// @@ -53,7 +53,7 @@ public class LevelRangeFilter : FilterSkeleton /// logging event, otherwise it will the event. /// /// - /// The default is true i.e. to the event. + /// The default is i.e. to the event. /// /// public bool AcceptOnMatch { get; set; } = true; diff --git a/src/log4net/Filter/LoggerMatchFilter.cs b/src/log4net/Filter/LoggerMatchFilter.cs index 52e5c1a5..87e48ce5 100644 --- a/src/log4net/Filter/LoggerMatchFilter.cs +++ b/src/log4net/Filter/LoggerMatchFilter.cs @@ -34,8 +34,8 @@ namespace log4net.Filter; /// of the starts /// with the value of the option, then the /// method returns in -/// case the option value is set to true, -/// if it is false then is returned. +/// case the option value is set to , +/// if it is then is returned. /// /// /// Daniel Cazzulino @@ -52,7 +52,7 @@ public class LoggerMatchFilter : FilterSkeleton /// logging event, otherwise it will the event. /// /// - /// The default is true i.e. to the event. + /// The default is i.e. to the event. /// /// public bool AcceptOnMatch { get; set; } = true; diff --git a/src/log4net/Filter/StringMatchFilter.cs b/src/log4net/Filter/StringMatchFilter.cs index bbb12b3e..8458fc7e 100644 --- a/src/log4net/Filter/StringMatchFilter.cs +++ b/src/log4net/Filter/StringMatchFilter.cs @@ -73,7 +73,7 @@ public override void ActivateOptions() /// logging event, otherwise it will the event. /// /// - /// The default is true i.e. to the event. + /// The default is i.e. to the event. /// /// public bool AcceptOnMatch { get; set; } = true; diff --git a/src/log4net/GlobalContext.cs b/src/log4net/GlobalContext.cs index 1ec153f0..01521752 100644 --- a/src/log4net/GlobalContext.cs +++ b/src/log4net/GlobalContext.cs @@ -26,7 +26,7 @@ namespace log4net; /// /// /// -/// The GlobalContext provides a location for global debugging +/// The provides a location for global debugging /// information to be stored. /// /// diff --git a/src/log4net/ILog.cs b/src/log4net/ILog.cs index 2e664676..5d172ecf 100644 --- a/src/log4net/ILog.cs +++ b/src/log4net/ILog.cs @@ -834,7 +834,7 @@ public interface ILog : ILoggerWrapper /// Checks if this logger is enabled for the level. /// /// - /// true if this logger is enabled for events, false otherwise. + /// if this logger is enabled for events, otherwise. /// /// /// @@ -905,7 +905,7 @@ public interface ILog : ILoggerWrapper /// Checks if this logger is enabled for the level. /// /// - /// true if this logger is enabled for events, false otherwise. + /// if this logger is enabled for events, otherwise. /// /// /// For more information see . @@ -919,7 +919,7 @@ public interface ILog : ILoggerWrapper /// Checks if this logger is enabled for the level. /// /// - /// true if this logger is enabled for events, false otherwise. + /// if this logger is enabled for events, otherwise. /// /// /// For more information see . @@ -933,7 +933,7 @@ public interface ILog : ILoggerWrapper /// Checks if this logger is enabled for the level. /// /// - /// true if this logger is enabled for events, false otherwise. + /// if this logger is enabled for events, otherwise. /// /// /// For more information see . @@ -947,7 +947,7 @@ public interface ILog : ILoggerWrapper /// Checks if this logger is enabled for the level. /// /// - /// true if this logger is enabled for events, false otherwise. + /// if this logger is enabled for events, otherwise. /// /// /// For more information see . diff --git a/src/log4net/Layout/ILayout.cs b/src/log4net/Layout/ILayout.cs index 381f28b0..c59b0080 100644 --- a/src/log4net/Layout/ILayout.cs +++ b/src/log4net/Layout/ILayout.cs @@ -105,13 +105,13 @@ public interface ILayout /// /// Flag indicating if this layout handle exceptions /// - /// false if this layout handles exceptions + /// if this layout handles exceptions /// /// /// If this layout handles the exception object contained within /// , then the layout should return - /// false. Otherwise, if the layout ignores the exception - /// object, then the layout should return true. + /// . Otherwise, if the layout ignores the exception + /// object, then the layout should return . /// /// bool IgnoresException { get; } diff --git a/src/log4net/Layout/LayoutSkeleton.cs b/src/log4net/Layout/LayoutSkeleton.cs index d026a173..57a10f91 100644 --- a/src/log4net/Layout/LayoutSkeleton.cs +++ b/src/log4net/Layout/LayoutSkeleton.cs @@ -103,7 +103,7 @@ protected LayoutSkeleton() /// public string Format(LoggingEvent loggingEvent) { - using var writer = new StringWriter(System.Globalization.CultureInfo.InvariantCulture); + using StringWriter writer = new(System.Globalization.CultureInfo.InvariantCulture); Format(writer, loggingEvent); return writer.ToString(); } @@ -151,17 +151,17 @@ public string Format(LoggingEvent loggingEvent) /// /// Flag indicating if this layout handles exceptions. /// - /// false if this layout handles exceptions + /// if this layout handles exceptions /// /// /// If this layout handles the exception object contained within /// , then the layout should return - /// false. Otherwise, if the layout ignores the exception - /// object, then the layout should return true. + /// . Otherwise, if the layout ignores the exception + /// object, then the layout should return . /// /// /// Set this value to override the default setting. The default - /// value is true, this layout does not handle the exception. + /// value is , this layout does not handle the exception. /// /// public virtual bool IgnoresException { get; set; } = true; diff --git a/src/log4net/Layout/Pattern/PatternLayoutConverter.cs b/src/log4net/Layout/Pattern/PatternLayoutConverter.cs index 9e4163f7..b7218aff 100644 --- a/src/log4net/Layout/Pattern/PatternLayoutConverter.cs +++ b/src/log4net/Layout/Pattern/PatternLayoutConverter.cs @@ -47,17 +47,17 @@ protected PatternLayoutConverter() /// /// Flag indicating if this converter handles the logging event exception /// - /// false if this converter handles the logging event exception + /// if this converter handles the logging event exception /// /// /// If this converter handles the exception object contained within /// , then this property should be set to - /// false. Otherwise, if the layout ignores the exception - /// object, then the property should be set to true. + /// . Otherwise, if the layout ignores the exception + /// object, then the property should be set to . /// /// /// Set this value to override a this default setting. The default - /// value is true, this converter does not handle the exception. + /// value is , this converter does not handle the exception. /// /// public virtual bool IgnoresException { get; set; } = true; diff --git a/src/log4net/Layout/Pattern/PropertyPatternConverter.cs b/src/log4net/Layout/Pattern/PropertyPatternConverter.cs index e44cc93e..9382badf 100644 --- a/src/log4net/Layout/Pattern/PropertyPatternConverter.cs +++ b/src/log4net/Layout/Pattern/PropertyPatternConverter.cs @@ -34,7 +34,7 @@ namespace log4net.Layout.Pattern; /// property. /// /// -/// If the is set to null +/// If the is set to /// then all the properties are written as key value pairs. /// /// @@ -54,7 +54,7 @@ internal sealed class PropertyPatternConverter : PatternLayoutConverter /// property. /// /// - /// If the is set to null + /// If the is set to /// then all the properties are written as key value pairs. /// /// diff --git a/src/log4net/Layout/RawLayoutConverter.cs b/src/log4net/Layout/RawLayoutConverter.cs index df61ce3a..b2bb171f 100644 --- a/src/log4net/Layout/RawLayoutConverter.cs +++ b/src/log4net/Layout/RawLayoutConverter.cs @@ -40,7 +40,7 @@ public class RawLayoutConverter : IConvertFrom /// Can the sourceType be converted to an /// /// the source to be to be converted - /// true if the source type can be converted to + /// if the source type can be converted to /// /// /// Test if the can be converted to a diff --git a/src/log4net/Layout/RawPropertyLayout.cs b/src/log4net/Layout/RawPropertyLayout.cs index 0a5f914c..cf06f6f1 100644 --- a/src/log4net/Layout/RawPropertyLayout.cs +++ b/src/log4net/Layout/RawPropertyLayout.cs @@ -42,7 +42,7 @@ public class RawPropertyLayout : IRawLayout /// /// Looks up and returns the object value of the property /// named . If there is no property defined - /// with than name then null will be returned. + /// with than name then will be returned. /// /// public virtual object? Format(LoggingEvent loggingEvent) diff --git a/src/log4net/Layout/XmlLayoutBase.cs b/src/log4net/Layout/XmlLayoutBase.cs index 705ec671..3c63b5ae 100644 --- a/src/log4net/Layout/XmlLayoutBase.cs +++ b/src/log4net/Layout/XmlLayoutBase.cs @@ -61,7 +61,7 @@ public abstract class XmlLayoutBase : LayoutSkeleton /// /// The parameter determines whether /// location information will be output by the layout. If - /// is set to true, then the + /// is set to , then the /// file name and line number of the statement at the origin of the log /// statement will be output. /// @@ -82,12 +82,12 @@ protected XmlLayoutBase(bool locationInfo) /// the XML events. /// /// - /// true if location information should be included in the XML - /// events; otherwise, false. + /// if location information should be included in the XML + /// events; otherwise, . /// /// /// - /// If is set to true, then the file + /// If is set to , then the file /// name and line number of the statement at the origin of the log /// statement will be output. /// diff --git a/src/log4net/LogManager.cs b/src/log4net/LogManager.cs index a4188d7a..2538b775 100644 --- a/src/log4net/LogManager.cs +++ b/src/log4net/LogManager.cs @@ -66,11 +66,11 @@ public static class LogManager /// /// /// If the named logger exists (in the default repository) then it - /// returns a reference to the logger, otherwise it returns null. + /// returns a reference to the logger, otherwise it returns . /// /// /// The fully qualified logger name to look for. - /// The logger found, or null if no logger could be found. + /// The logger found, or if no logger could be found. public static ILog? Exists(string name) => Exists(Assembly.GetCallingAssembly(), name); /// Get the currently defined loggers. @@ -110,13 +110,13 @@ public static class LogManager /// /// If the named logger exists (in the specified repository) then it /// returns a reference to the logger, otherwise it returns - /// null. + /// . /// /// /// The repository to lookup in. /// The fully qualified logger name to look for. /// - /// The logger found, or null if the logger doesn't exist in the specified + /// The logger found, or if the logger doesn't exist in the specified /// repository. /// public static ILog? Exists(string repository, string name) => WrapLogger(LoggerManager.Exists(repository, name)); @@ -128,13 +128,13 @@ public static class LogManager /// /// If the named logger exists (in the repository for the specified assembly) then it /// returns a reference to the logger, otherwise it returns - /// null. + /// . /// /// /// The assembly to use to look up the repository. /// The fully qualified logger name to look for. /// - /// The logger, or null if the logger doesn't exist in the specified + /// The logger, or if the logger doesn't exist in the specified /// assembly's repository. /// public static ILog? Exists(Assembly repositoryAssembly, string name) => WrapLogger(LoggerManager.Exists(repositoryAssembly, name)); @@ -333,8 +333,8 @@ public static ILog GetLogger(Assembly repositoryAssembly, Type type) /// /// Resets all values contained in the repository instance to their /// defaults. This removes all appenders from all loggers, sets - /// the level of all non-root loggers to null, - /// sets their additivity flag to true and sets the level + /// the level of all non-root loggers to , + /// sets their additivity flag to and sets the level /// of the root logger to . Moreover, /// message disabling is set to its default "off" value. /// @@ -348,8 +348,8 @@ public static ILog GetLogger(Assembly repositoryAssembly, Type type) /// /// Reset all values contained in the repository instance to their /// defaults. This removes all appenders from all loggers, sets - /// the level of all non-root loggers to null, - /// sets their additivity flag to true and sets the level + /// the level of all non-root loggers to , + /// sets their additivity flag to and sets the level /// of the root logger to . Moreover, /// message disabling is set to its default "off" value. /// @@ -364,8 +364,8 @@ public static ILog GetLogger(Assembly repositoryAssembly, Type type) /// /// Reset all values contained in the repository instance to their /// defaults. This removes all appenders from all loggers, sets - /// the level of all non-root loggers to null, - /// sets their additivity flag to true and sets the level + /// the level of all non-root loggers to , + /// sets their additivity flag to and sets the level /// of the root logger to . Moreover, /// message disabling is set to its default "off" value. /// @@ -496,7 +496,7 @@ public static ILog GetLogger(Assembly repositoryAssembly, Type type) /// Flushes logging events buffered in all configured appenders in the default repository. /// /// The maximum time in milliseconds to wait for logging events from asynchronous appenders to be flushed. - /// True if all logging events were flushed successfully, else false. + /// if all logging events were flushed successfully, else . public static bool Flush(int millisecondsTimeout) { if (LoggerManager.GetRepository(Assembly.GetCallingAssembly()) is not IFlushable flushableRepository) @@ -522,7 +522,7 @@ public static bool Flush(int millisecondsTimeout) /// The wrapper objects for the loggers specified. private static ILog[] WrapLoggers(ILogger[] loggers) { - var results = new ILog[loggers.Length]; + ILog[] results = new ILog[loggers.Length]; for (int i = 0; i < loggers.Length; i++) { results[i] = WrapLogger(loggers[i]); diff --git a/src/log4net/LogicalThreadContext.cs b/src/log4net/LogicalThreadContext.cs index f0b26fa7..13e7e1de 100644 --- a/src/log4net/LogicalThreadContext.cs +++ b/src/log4net/LogicalThreadContext.cs @@ -32,9 +32,9 @@ namespace log4net; /// /// /// -/// The LogicalThreadContext provides a location for specific debugging +/// The provides a location for specific debugging /// information to be stored. -/// The LogicalThreadContext properties override any or +/// The properties override any or /// properties with the same name. /// /// @@ -87,7 +87,7 @@ public static class LogicalThreadContext /// /// /// - /// The LogicalThreadContext properties override any + /// The properties override any /// or properties with the same name. /// /// diff --git a/src/log4net/MDC.cs b/src/log4net/MDC.cs index ba27661b..edc67a85 100644 --- a/src/log4net/MDC.cs +++ b/src/log4net/MDC.cs @@ -51,7 +51,7 @@ public static class MDC /// Gets the context value identified by the parameter. /// /// The key to lookup in the MDC. - /// The string value held for the key, or a null reference if no corresponding value is found. + /// The string value held for the key, or a reference if no corresponding value is found. /// /// /// @@ -61,7 +61,7 @@ public static class MDC /// /// /// If the parameter does not look up to a - /// previously defined context then null will be returned. + /// previously defined context then will be returned. /// /// /*[Obsolete("MDC has been replaced by ThreadContext.Properties")]*/ @@ -87,7 +87,7 @@ public static class MDC /// /// If a value is already defined for the /// specified then the value will be replaced. If the - /// is specified as null then the key value mapping will be removed. + /// is specified as then the key value mapping will be removed. /// /// /*[Obsolete("MDC has been replaced by ThreadContext.Properties")]*/ diff --git a/src/log4net/NDC.cs b/src/log4net/NDC.cs index ccc1502a..57d3eb37 100644 --- a/src/log4net/NDC.cs +++ b/src/log4net/NDC.cs @@ -165,7 +165,7 @@ public static class NDC /// /// Remove the top context from the stack, and return /// it to the caller. If the stack is empty then an - /// empty string (not null) is returned. + /// empty string (not ) is returned. /// /// /*[Obsolete("NDC has been replaced by ThreadContext.Stacks")]*/ @@ -189,11 +189,11 @@ public static class NDC /// /// Pushes a new context onto the context stack. An /// is returned that can be used to clean up the context stack. This - /// can be easily combined with the using keyword to scope the + /// can be easily combined with the keyword to scope the /// context. /// /// - /// Simple example of using the Push method with the using keyword. + /// Simple example of using the method with the keyword. /// /// using(log4net.NDC.Push("NDC_Message")) /// { @@ -223,11 +223,11 @@ public static class NDC /// /// Pushes a new context onto the context stack. An /// is returned that can be used to clean up the context stack. This - /// can be easily combined with the using keyword to scope the + /// can be easily combined with the keyword to scope the /// context. /// /// - /// Simple example of using the Push method with the using keyword. + /// Simple example of using the method with the keyword. /// /// var someValue = "ExampleContext" /// using(log4net.NDC.PushFormat("NDC_Message {0}", someValue)) diff --git a/src/log4net/ObjectRenderer/DefaultRenderer.cs b/src/log4net/ObjectRenderer/DefaultRenderer.cs index 62cd98c7..2dbfc8d1 100644 --- a/src/log4net/ObjectRenderer/DefaultRenderer.cs +++ b/src/log4net/ObjectRenderer/DefaultRenderer.cs @@ -66,7 +66,7 @@ public sealed class DefaultRenderer : IObjectRenderer /// Rendered String /// /// - /// null + /// /// /// "(null)" /// diff --git a/src/log4net/ObjectRenderer/RendererMap.cs b/src/log4net/ObjectRenderer/RendererMap.cs index e005a96b..7d365734 100644 --- a/src/log4net/ObjectRenderer/RendererMap.cs +++ b/src/log4net/ObjectRenderer/RendererMap.cs @@ -31,7 +31,7 @@ namespace log4net.ObjectRenderer; /// /// /// The method is used to render an -/// object using the appropriate renderers defined in this map, +/// using the appropriate renderers defined in this map, /// using a default renderer if no custom renderer is defined for a type. /// /// @@ -189,7 +189,7 @@ public IObjectRenderer Get(Type type) /// Recursively searches interfaces. /// /// The type for which to look up the renderer. - /// The renderer for the specified type, or null if not found. + /// The renderer for the specified type, or if not found. private IObjectRenderer? SearchTypeAndInterfaces(Type type) { if (_map.TryGetValue(type, out IObjectRenderer? r)) diff --git a/src/log4net/Plugin/PluginCollection.cs b/src/log4net/Plugin/PluginCollection.cs index bd87fe51..b836f9b5 100644 --- a/src/log4net/Plugin/PluginCollection.cs +++ b/src/log4net/Plugin/PluginCollection.cs @@ -45,8 +45,8 @@ public interface IPluginCollectionEnumerator /// Advances the enumerator to the next element in the collection. /// /// - /// true if the enumerator was successfully advanced to the next element; - /// false if the enumerator has passed the end of the collection. + /// if the enumerator was successfully advanced to the next element; + /// if the enumerator has passed the end of the collection. /// /// /// The collection was modified after the enumerator was created. @@ -66,35 +66,35 @@ public interface IPluginCollectionEnumerator private int _version; /// - /// Creates a read-only wrapper for a PluginCollection instance. + /// Creates a read-only wrapper for a instance. /// /// list to create a readonly wrapper arround /// - /// A PluginCollection wrapper that is read-only. + /// A wrapper that is read-only. /// public static PluginCollection ReadOnly(PluginCollection list) => new ReadOnlyPluginCollection(list.EnsureNotNull()); /// - /// Initializes a new instance of the PluginCollection class + /// Initializes a new instance of the class /// that is empty and has the default initial capacity. /// public PluginCollection() => _array = new IPlugin[DefaultCapacity]; /// - /// Initializes a new instance of the PluginCollection class + /// Initializes a new instance of the class /// that has the specified initial capacity. /// /// - /// The number of elements that the new PluginCollection is initially capable of storing. + /// The number of elements that the new is initially capable of storing. /// public PluginCollection(int capacity) => _array = new IPlugin[capacity]; /// - /// Initializes a new instance of the PluginCollection class - /// that contains elements copied from the specified PluginCollection. + /// Initializes a new instance of the class + /// that contains elements copied from the specified . /// - /// The PluginCollection whose elements are copied to the new collection. + /// The whose elements are copied to the new collection. [System.Diagnostics.CodeAnalysis.SuppressMessage("Usage", "CA2214:Do not call overridable methods in constructors")] public PluginCollection(PluginCollection collection) { @@ -103,7 +103,7 @@ public PluginCollection(PluginCollection collection) } /// - /// Initializes a new instance of the PluginCollection class + /// Initializes a new instance of the class /// that contains elements copied from the specified array. /// /// The array whose elements are copied to the new list. @@ -115,7 +115,7 @@ public PluginCollection(IPlugin[] array) } /// - /// Initializes a new instance of the PluginCollection class + /// Initializes a new instance of the class /// that contains elements copied from the specified collection. /// /// The collection whose elements are copied to the new list. @@ -127,7 +127,7 @@ public PluginCollection(ICollection collection) } /// - /// Initializes a new instance of the PluginCollection class + /// Initializes a new instance of the class /// that contains elements copied from the specified collection. /// /// The collection whose elements are copied to the new list. @@ -158,19 +158,19 @@ protected internal enum Tag protected internal PluginCollection(Tag _) => _array = Array.Empty(); /// - /// Gets the number of elements actually contained in the PluginCollection. + /// Gets the number of elements actually contained in the . /// public virtual int Count => _count; /// - /// Copies the entire PluginCollection to a one-dimensional + /// Copies the entire to a one-dimensional /// array. /// /// The one-dimensional array to copy to. public virtual void CopyTo(IPlugin[] array) => CopyTo(array, 0); /// - /// Copies the entire PluginCollection to a one-dimensional + /// Copies the entire to a one-dimensional /// array, starting at the specified index of the target array. /// /// The one-dimensional array to copy to. @@ -224,9 +224,9 @@ public virtual IPlugin this[int index] } /// - /// Adds a to the end of the PluginCollection. + /// Adds a to the end of the . /// - /// The to be added to the end of the PluginCollection. + /// The to be added to the end of the . /// The index at which the value has been added. public virtual int Add(IPlugin item) { @@ -242,7 +242,7 @@ public virtual int Add(IPlugin item) } /// - /// Removes all elements from the PluginCollection. + /// Removes all elements from the . /// public virtual void Clear() { @@ -257,7 +257,7 @@ public virtual void Clear() /// A new with a shallow copy of the collection data. public virtual object Clone() { - var newCol = new PluginCollection(_count); + PluginCollection newCol = new(_count); Array.Copy(_array, 0, newCol._array, 0, _count); newCol._count = _count; newCol._version = _version; @@ -266,10 +266,10 @@ public virtual object Clone() } /// - /// Determines whether a given is in the PluginCollection. + /// Determines whether a given is in the . /// /// The to check for. - /// true if is found in the PluginCollection; otherwise, false. + /// if is found in the ; otherwise, . public virtual bool Contains(IPlugin item) { for (int i = 0; i != _count; ++i) @@ -284,12 +284,12 @@ public virtual bool Contains(IPlugin item) /// /// Returns the zero-based index of the first occurrence of a - /// in the PluginCollection. + /// in the . /// - /// The to locate in the PluginCollection. + /// The to locate in the . /// /// The zero-based index of the first occurrence of - /// in the entire PluginCollection, if found; otherwise, -1. + /// in the entire , if found; otherwise, -1. /// public virtual int IndexOf(IPlugin item) { @@ -304,7 +304,7 @@ public virtual int IndexOf(IPlugin item) } /// - /// Inserts an element into the PluginCollection at the specified index. + /// Inserts an element into the at the specified index. /// /// The zero-based index at which should be inserted. /// The to insert. @@ -333,11 +333,11 @@ public virtual void Insert(int index, IPlugin item) } /// - /// Removes the first occurrence of a specific from the PluginCollection. + /// Removes the first occurrence of a specific from the . /// - /// The to remove from the PluginCollection. + /// The to remove from the . /// - /// The specified was not found in the PluginCollection. + /// The specified was not found in the . /// public virtual void Remove(IPlugin item) { @@ -351,7 +351,7 @@ public virtual void Remove(IPlugin item) } /// - /// Removes the element at the specified index of the PluginCollection. + /// Removes the element at the specified index of the . /// /// The zero-based index of the element to remove. /// @@ -381,26 +381,26 @@ public virtual void RemoveAt(int index) /// /// Gets a value indicating whether the collection has a fixed size. /// - /// true if the collection has a fixed size; otherwise, false. The default is false. + /// if the collection has a fixed size; otherwise, . The default is . public virtual bool IsFixedSize => false; /// /// Gets a value indicating whether the IList is read-only. /// - /// true if the collection is read-only; otherwise, false. The default is false. + /// if the collection is read-only; otherwise, . The default is . public virtual bool IsReadOnly => false; /// - /// Returns an enumerator that can iterate through the PluginCollection. + /// Returns an enumerator that can iterate through the . /// - /// An for the entire PluginCollection. + /// An for the entire . public virtual IPluginCollectionEnumerator GetEnumerator() => new Enumerator(this); /// - /// Gets or sets the number of elements the PluginCollection can contain. + /// Gets or sets the number of elements the can contain. /// /// - /// The number of elements the PluginCollection can contain. + /// The number of elements the can contain. /// public virtual int Capacity { @@ -429,10 +429,10 @@ public virtual int Capacity } /// - /// Adds the elements of another PluginCollection to the current PluginCollection. + /// Adds the elements of another to the current . /// - /// The PluginCollection whose elements should be added to the end of the current PluginCollection. - /// The new of the PluginCollection. + /// The whose elements should be added to the end of the current . + /// The new of the . public virtual int AddRange(PluginCollection collection) { if (_count + collection.EnsureNotNull().Count >= _array.Length) @@ -448,10 +448,10 @@ public virtual int AddRange(PluginCollection collection) } /// - /// Adds the elements of a array to the current PluginCollection. + /// Adds the elements of a array to the current . /// - /// The array whose elements should be added to the end of the PluginCollection. - /// The new of the PluginCollection. + /// The array whose elements should be added to the end of the . + /// The new of the . public virtual int AddRange(IPlugin[] array) { if (_count + array.EnsureNotNull().Length >= _array.Length) @@ -467,10 +467,10 @@ public virtual int AddRange(IPlugin[] array) } /// - /// Adds the elements of a collection to the current PluginCollection. + /// Adds the elements of a collection to the current . /// - /// The collection whose elements should be added to the end of the PluginCollection. - /// The new of the PluginCollection. + /// The collection whose elements should be added to the end of the . + /// The new of the . public virtual int AddRange(ICollection collection) { if (_count + collection.EnsureNotNull().Count >= _array.Length) @@ -487,10 +487,10 @@ public virtual int AddRange(ICollection collection) } /// - /// Adds the elements of a collection to the current PluginCollection. + /// Adds the elements of a collection to the current . /// - /// The collection whose elements should be added to the end of the PluginCollection. - /// The new of the PluginCollection. + /// The collection whose elements should be added to the end of the . + /// The new of the . public virtual int AddRange(ICollection collection) { if (_count + collection.EnsureNotNull().Count >= _array.Length) @@ -576,7 +576,7 @@ private sealed class Enumerator : IEnumerator, IPluginCollectionEnumerator private readonly int _version; /// - /// Initializes a new instance of the Enumerator class. + /// Initializes a new instance of the class. /// /// internal Enumerator(PluginCollection tc) @@ -595,8 +595,8 @@ internal Enumerator(PluginCollection tc) /// Advances the enumerator to the next element in the collection. /// /// - /// true if the enumerator was successfully advanced to the next element; - /// false if the enumerator has passed the end of the collection. + /// if the enumerator was successfully advanced to the next element; + /// if the enumerator has passed the end of the collection. /// /// /// The collection was modified after the enumerator was created. diff --git a/src/log4net/Plugin/PluginMap.cs b/src/log4net/Plugin/PluginMap.cs index 2fdf58a3..eb1cda27 100644 --- a/src/log4net/Plugin/PluginMap.cs +++ b/src/log4net/Plugin/PluginMap.cs @@ -44,7 +44,7 @@ public sealed class PluginMap(ILoggerRepository repository) /// The name of the to lookup. /// /// The from the map with the name specified, or - /// null if no plugin is found. + /// if no plugin is found. /// public IPlugin? this[string name] { diff --git a/src/log4net/Repository/Hierarchy/DefaultLoggerFactory.cs b/src/log4net/Repository/Hierarchy/DefaultLoggerFactory.cs index 60ea16c6..a5d7b598 100644 --- a/src/log4net/Repository/Hierarchy/DefaultLoggerFactory.cs +++ b/src/log4net/Repository/Hierarchy/DefaultLoggerFactory.cs @@ -39,7 +39,7 @@ internal sealed class DefaultLoggerFactory : ILoggerFactory /// Create a new instance with the specified name. /// /// The that will own the . - /// The name of the . If null, the root logger is returned. + /// The name of the . If , the root logger is returned. /// The instance for the specified name. /// /// diff --git a/src/log4net/Repository/Hierarchy/ILoggerFactory.cs b/src/log4net/Repository/Hierarchy/ILoggerFactory.cs index 27cdb245..79f277a2 100644 --- a/src/log4net/Repository/Hierarchy/ILoggerFactory.cs +++ b/src/log4net/Repository/Hierarchy/ILoggerFactory.cs @@ -55,7 +55,7 @@ public interface ILoggerFactory /// new named instances. /// /// - /// If the is null then the root logger + /// If the is then the root logger /// must be returned. /// /// diff --git a/src/log4net/Repository/Hierarchy/RootLogger.cs b/src/log4net/Repository/Hierarchy/RootLogger.cs index a32e8cea..6681af2a 100644 --- a/src/log4net/Repository/Hierarchy/RootLogger.cs +++ b/src/log4net/Repository/Hierarchy/RootLogger.cs @@ -33,7 +33,7 @@ namespace log4net.Repository.Hierarchy; /// that it provides several guarantees. /// /// -/// First, it cannot be assigned a null +/// First, it cannot be assigned a /// level. Second, since the root logger cannot have a parent, the /// property always returns the value of the /// level field without walking the hierarchy. @@ -69,7 +69,7 @@ public RootLogger(Level level) : base("root") /// /// /// Because the root logger cannot have a parent and its level - /// must not be null this property just returns the + /// must not be this property just returns the /// value of . /// /// @@ -83,7 +83,7 @@ public RootLogger(Level level) : base("root") /// /// /// - /// Setting the level of the root logger to a null reference + /// Setting the level of the root logger to a reference /// may have catastrophic results. We prevent this here. /// /// diff --git a/src/log4net/Repository/Hierarchy/XmlHierarchyConfigurator.cs b/src/log4net/Repository/Hierarchy/XmlHierarchyConfigurator.cs index 1ec9c1a9..0e2f45eb 100644 --- a/src/log4net/Repository/Hierarchy/XmlHierarchyConfigurator.cs +++ b/src/log4net/Repository/Hierarchy/XmlHierarchyConfigurator.cs @@ -258,7 +258,7 @@ public void Configure(XmlElement? element) /// Parses an appender element. /// /// The appender element. - /// The appender instance or null when parsing failed. + /// The appender instance or when parsing failed. /// /// /// Parse an XML element that represents an appender and return @@ -777,7 +777,7 @@ protected void SetParameter(XmlElement element, object target) /// Test if an element has no attributes or child elements /// /// the element to inspect - /// true if the element has any attributes or child elements, false otherwise + /// if the element has any attributes or child elements, otherwise private static bool HasAttributesOrElements(XmlElement element) => element.ChildNodes.OfType().Any(node => node.NodeType is XmlNodeType.Attribute or XmlNodeType.Element); @@ -785,7 +785,7 @@ private static bool HasAttributesOrElements(XmlElement element) /// Test if a is constructible with Activator.CreateInstance. /// /// the type to inspect - /// true if the type is creatable using a default constructor, false otherwise + /// if the type is creatable using a default constructor, otherwise private static bool IsTypeConstructible(Type type) { return type.IsClass && !type.IsAbstract @@ -844,7 +844,7 @@ private static bool IsTypeConstructible(Type type) /// /// /// An object of type with value or - /// null when the conversion could not be performed. + /// when the conversion could not be performed. /// /// protected object? ConvertStringTo(Type type, string value) @@ -871,7 +871,7 @@ private static bool IsTypeConstructible(Type type) /// The XML element that contains the definition of the object. /// The object type to use if not explicitly specified. /// The type that the returned object must be or must inherit from. - /// The object or null + /// The object or /// /// /// Parse an XML element and create an object instance based on the configuration diff --git a/src/log4net/Repository/ILoggerRepository.cs b/src/log4net/Repository/ILoggerRepository.cs index 0614e393..1f99ae14 100644 --- a/src/log4net/Repository/ILoggerRepository.cs +++ b/src/log4net/Repository/ILoggerRepository.cs @@ -88,10 +88,10 @@ public interface ILoggerRepository Level Threshold { get; set; } /// - /// Gets the named logger, or null. + /// Gets the named logger, or . /// /// The name of the logger to look up. - /// The logger if found, or null. + /// The logger if found, or . ILogger? Exists(string name); /// diff --git a/src/log4net/Repository/LoggerRepositorySkeleton.cs b/src/log4net/Repository/LoggerRepositorySkeleton.cs index 94b16149..ce142330 100644 --- a/src/log4net/Repository/LoggerRepositorySkeleton.cs +++ b/src/log4net/Repository/LoggerRepositorySkeleton.cs @@ -176,7 +176,7 @@ public virtual Level Threshold /// /// /// Check if the named logger exists in the repository. If so return - /// its reference, otherwise returns null. + /// its reference, otherwise returns . /// /// public abstract ILogger? Exists(string name); @@ -474,7 +474,7 @@ private static int GetWaitTime(DateTime startTimeUtc, int millisecondsTimeout) /// /// The maximum time in milliseconds to wait for logging events from asynchronous appenders to be flushed, /// or to wait indefinitely. - /// True if all logging events were flushed successfully, else false. + /// if all logging events were flushed successfully, else . public bool Flush(int millisecondsTimeout) { if (millisecondsTimeout < -1) diff --git a/src/log4net/ThreadContext.cs b/src/log4net/ThreadContext.cs index d7d25a6b..f5821910 100644 --- a/src/log4net/ThreadContext.cs +++ b/src/log4net/ThreadContext.cs @@ -26,9 +26,9 @@ namespace log4net; /// /// /// -/// The ThreadContext provides a location for thread specific debugging +/// The provides a location for thread specific debugging /// information to be stored. -/// The ThreadContext properties override any +/// The properties override any /// properties with the same name. /// /// @@ -74,7 +74,7 @@ public static class ThreadContext /// /// /// - /// The ThreadContext properties override any + /// The properties override any /// properties with the same name. /// /// diff --git a/src/log4net/Util/AppenderAttachedImpl.cs b/src/log4net/Util/AppenderAttachedImpl.cs index e1ed3502..e8c71953 100644 --- a/src/log4net/Util/AppenderAttachedImpl.cs +++ b/src/log4net/Util/AppenderAttachedImpl.cs @@ -185,7 +185,7 @@ public void AddAppender(IAppender appender) /// Gets all attached appenders. /// /// - /// A collection of attached appenders, or null if there + /// A collection of attached appenders, or if there /// are no attached appenders. /// /// @@ -211,7 +211,7 @@ public AppenderCollection Appenders /// /// The name of the appender to get. /// - /// The appender with the name specified, or null if no appender with the + /// The appender with the name specified, or if no appender with the /// specified name is found. /// /// diff --git a/src/log4net/Util/CompositeProperties.cs b/src/log4net/Util/CompositeProperties.cs index e50a2f45..9eb5dc9d 100644 --- a/src/log4net/Util/CompositeProperties.cs +++ b/src/log4net/Util/CompositeProperties.cs @@ -63,7 +63,7 @@ internal CompositeProperties() /// /// /// If none of the collections contain the specified key then - /// null is returned. + /// is returned. /// /// public object? this[string key] diff --git a/src/log4net/Util/CyclicBuffer.cs b/src/log4net/Util/CyclicBuffer.cs index 3ae5ae1f..c376d070 100644 --- a/src/log4net/Util/CyclicBuffer.cs +++ b/src/log4net/Util/CyclicBuffer.cs @@ -66,11 +66,11 @@ public CyclicBuffer(int maxSize) /// Appends a to the buffer. /// /// The event to append to the buffer. - /// The event discarded from the buffer, if the buffer is full, otherwise null. + /// The event discarded from the buffer, if the buffer is full, otherwise . /// /// /// Append an event to the buffer. If the buffer still contains free space then - /// null is returned. If the buffer is full then an event will be dropped + /// is returned. If the buffer is full then an event will be dropped /// to make space for the new event, the dropped event is returned. /// /// @@ -258,7 +258,7 @@ public void Resize(int newSize) /// /// /// If is outside the range 0 to the number of events - /// currently in the buffer, then null is returned. + /// currently in the buffer, then is returned. /// /// public LoggingEvent? this[int i] diff --git a/src/log4net/Util/EmptyCollection.cs b/src/log4net/Util/EmptyCollection.cs index a5424c1e..9e7528c9 100644 --- a/src/log4net/Util/EmptyCollection.cs +++ b/src/log4net/Util/EmptyCollection.cs @@ -87,7 +87,7 @@ public void CopyTo(Array array, int index) /// /// /// - /// For the this property is always true. + /// For the this property is always . /// /// public bool IsSynchronized => true; diff --git a/src/log4net/Util/EmptyDictionary.cs b/src/log4net/Util/EmptyDictionary.cs index c6432f91..e80f227c 100644 --- a/src/log4net/Util/EmptyDictionary.cs +++ b/src/log4net/Util/EmptyDictionary.cs @@ -165,10 +165,10 @@ public void CopyTo(System.Array array, int index) /// with the specified key. /// /// The key to locate in the . - /// false + /// /// /// - /// As the collection is empty the method always returns false. + /// As the collection is empty the method always returns . /// /// public bool Contains(object key) => false; @@ -203,10 +203,10 @@ public void CopyTo(System.Array array, int index) /// /// Gets a value indicating whether the has a fixed size. /// - /// true + /// /// /// - /// As the collection is empty always returns true. + /// As the collection is empty always returns . /// /// public bool IsFixedSize => true; @@ -214,10 +214,10 @@ public void CopyTo(System.Array array, int index) /// /// Gets a value indicating whether the is read-only. /// - /// true + /// /// /// - /// As the collection is empty always returns true. + /// As the collection is empty always returns . /// /// public bool IsReadOnly => true; @@ -248,11 +248,11 @@ public void CopyTo(System.Array array, int index) /// Gets or sets the element with the specified key. /// /// The key of the element to get or set. - /// null + /// /// /// /// As the collection is empty no values can be looked up or stored. - /// If the index getter is called then null is returned. + /// If the index getter is called then is returned. /// A is thrown if the setter is called. /// /// diff --git a/src/log4net/Util/GlobalContextProperties.cs b/src/log4net/Util/GlobalContextProperties.cs index efdd59eb..87f9c365 100644 --- a/src/log4net/Util/GlobalContextProperties.cs +++ b/src/log4net/Util/GlobalContextProperties.cs @@ -40,7 +40,7 @@ public sealed class GlobalContextProperties : ContextPropertiesBase /// /// /// - /// This variable is declared volatile to prevent the compiler and JIT from + /// This variable is declared to prevent the compiler and JIT from /// reordering reads and writes of this thread performed on different threads. /// /// @@ -83,7 +83,7 @@ public override object? this[string key] { lock (_syncRoot) { - var mutableProps = new PropertiesDictionary(_readOnlyProperties) + PropertiesDictionary mutableProps = new(_readOnlyProperties) { [key] = value }; @@ -108,7 +108,7 @@ public void Remove(string key) { if (_readOnlyProperties.Contains(key)) { - var mutableProps = new PropertiesDictionary(_readOnlyProperties); + PropertiesDictionary mutableProps = new(_readOnlyProperties); mutableProps.Remove(key); _readOnlyProperties = new ReadOnlyPropertiesDictionary(mutableProps); } diff --git a/src/log4net/Util/LogLog.cs b/src/log4net/Util/LogLog.cs index 121bb4b3..05dacb5c 100644 --- a/src/log4net/Util/LogLog.cs +++ b/src/log4net/Util/LogLog.cs @@ -121,12 +121,12 @@ public LogLog(Type source, string prefix, string message, Exception? exception) /// /// The log4net.Internal.Debug application setting /// controls internal debugging. This setting should be set - /// to true to enable debugging. + /// to to enable debugging. /// /// /// The log4net.Internal.Quiet application setting /// suppresses all internal logging including error messages. - /// This setting should be set to true to enable message + /// This setting should be set to to enable message /// suppression. /// /// @@ -153,12 +153,12 @@ static LogLog() /// is enabled or disabled. /// /// - /// true if log4net internal logging is enabled, otherwise - /// false. + /// if log4net internal logging is enabled, otherwise + /// . /// /// /// - /// When set to true, internal debug level logging will be + /// When set to , internal debug level logging will be /// displayed. /// /// @@ -167,7 +167,7 @@ static LogLog() /// file. /// /// - /// The default value is false, i.e. debugging is + /// The default value is , i.e. debugging is /// disabled. /// /// @@ -191,12 +191,12 @@ static LogLog() /// from internal logging, not even for errors. /// /// - /// true if log4net should generate no output at all from internal - /// logging, otherwise false. + /// if log4net should generate no output at all from internal + /// logging, otherwise . /// /// /// - /// When set to true will cause internal logging at all levels to be + /// When set to will cause internal logging at all levels to be /// suppressed. This means that no warning or error reports will be logged. /// This option overrides the setting and /// disables all debug also. @@ -205,7 +205,7 @@ static LogLog() /// log4net.Internal.Quiet in the application configuration file. /// /// - /// The default value is false, i.e. internal logging is not + /// The default value is , i.e. internal logging is not /// disabled. /// /// @@ -259,7 +259,7 @@ public static void ExecuteWithoutEmittingInternalMessages(Action callback) /// Test if LogLog.Debug is enabled for output. /// /// - /// true if Debug is enabled + /// if Debug is enabled /// /// /// @@ -327,7 +327,7 @@ public static void Debug(Type source, string message, Exception? exception) /// Test if LogLog.Warn is enabled for output. /// /// - /// true if Warn is enabled + /// if Warn is enabled /// public static bool IsWarnEnabled => !QuietMode; @@ -390,7 +390,7 @@ public static void Warn(Type source, string message, Exception? exception) /// Test if LogLog.Error is enabled for output. /// /// - /// true if Error is enabled + /// if Error is enabled /// /// /// diff --git a/src/log4net/Util/LogicalThreadContextProperties.cs b/src/log4net/Util/LogicalThreadContextProperties.cs index b7ea8f4b..4798fffe 100644 --- a/src/log4net/Util/LogicalThreadContextProperties.cs +++ b/src/log4net/Util/LogicalThreadContextProperties.cs @@ -82,7 +82,7 @@ public override object? this[string key] PropertiesDictionary props = GetProperties(true)!; // Reason for cloning the dictionary below: object instances set on the CallContext // need to be immutable to correctly flow through async/await - var immutableProps = new PropertiesDictionary(props) + PropertiesDictionary immutableProps = new(props) { [key] = value }; diff --git a/src/log4net/Util/LogicalThreadContextStack.cs b/src/log4net/Util/LogicalThreadContextStack.cs index 0e067db8..fb4b1bfc 100644 --- a/src/log4net/Util/LogicalThreadContextStack.cs +++ b/src/log4net/Util/LogicalThreadContextStack.cs @@ -131,11 +131,11 @@ internal LogicalThreadContextStack(string propertyKey, TwoArgAction /// Pushes a new context onto this stack. An /// is returned that can be used to clean up this stack. This - /// can be easily combined with the using keyword to scope the + /// can be easily combined with the keyword to scope the /// context. /// /// - /// Simple example of using the Push method with the using keyword. + /// Simple example of using the method with the keyword. /// /// using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message")) /// { diff --git a/src/log4net/Util/NativeError.cs b/src/log4net/Util/NativeError.cs index 6bc6a214..53479efb 100644 --- a/src/log4net/Util/NativeError.cs +++ b/src/log4net/Util/NativeError.cs @@ -94,7 +94,7 @@ public static NativeError GetLastError() /// native Win32 FormatMessage function. /// /// - public static NativeError GetError(int number) => new NativeError(number, GetErrorMessage(number)); + public static NativeError GetError(int number) => new(number, GetErrorMessage(number)); /// /// Retrieves the message corresponding with a Win32 message identifier. diff --git a/src/log4net/Util/NullDictionaryEnumerator.cs b/src/log4net/Util/NullDictionaryEnumerator.cs index d227e0d1..689cf060 100644 --- a/src/log4net/Util/NullDictionaryEnumerator.cs +++ b/src/log4net/Util/NullDictionaryEnumerator.cs @@ -74,12 +74,12 @@ private NullDictionaryEnumerator() /// /// Test if the enumerator can advance, if so advance. /// - /// false as the cannot advance. + /// as the cannot advance. /// /// /// As the enumerator is over an empty collection its /// value cannot be moved over a valid position, therefore - /// will always return false. + /// will always return . /// /// public bool MoveNext() => false; diff --git a/src/log4net/Util/NullEnumerator.cs b/src/log4net/Util/NullEnumerator.cs index 836828e3..c242f289 100644 --- a/src/log4net/Util/NullEnumerator.cs +++ b/src/log4net/Util/NullEnumerator.cs @@ -74,12 +74,12 @@ private NullEnumerator() /// /// Test if the enumerator can advance, if so advance /// - /// false as the cannot advance. + /// as the cannot advance. /// /// /// As the enumerator is over an empty collection its /// value cannot be moved over a valid position, therefore - /// will always return false. + /// will always return . /// /// public bool MoveNext() => false; diff --git a/src/log4net/Util/NullSecurityContext.cs b/src/log4net/Util/NullSecurityContext.cs index 5a1c239b..3332db90 100644 --- a/src/log4net/Util/NullSecurityContext.cs +++ b/src/log4net/Util/NullSecurityContext.cs @@ -62,10 +62,10 @@ private NullSecurityContext() /// Impersonate this SecurityContext /// /// State supplied by the caller - /// null + /// /// /// - /// No impersonation is done and null is always returned. + /// No impersonation is done and is always returned. /// /// public override IDisposable? Impersonate(object state) => null; diff --git a/src/log4net/Util/OptionConverter.cs b/src/log4net/Util/OptionConverter.cs index 3e9539cd..141362ef 100644 --- a/src/log4net/Util/OptionConverter.cs +++ b/src/log4net/Util/OptionConverter.cs @@ -47,8 +47,8 @@ public static class OptionConverter /// The value of . /// /// - /// If is "true", then true is returned. - /// If is "false", then false is returned. + /// If is "true", then is returned. + /// If is "false", then is returned. /// Otherwise, is returned. /// /// @@ -131,7 +131,7 @@ public static long ToFileSize(string? argValue, long defaultValue) /// The target type to convert to. /// The string to convert to an object. /// - /// The object converted from a string or null when the + /// The object converted from a string or when the /// conversion failed. /// /// @@ -179,7 +179,7 @@ public static long ToFileSize(string? argValue, long defaultValue) /// /// The type to convert from. /// The type to convert to. - /// true if there is a conversion from the source type to the target type. + /// if there is a conversion from the source type to the target type. /// /// Checks if there is an appropriate type conversion from the source type to the target type. /// @@ -384,7 +384,7 @@ public static string SubstituteVariables(string value, System.Collections.IDicti /// /// The type to convert to. /// The enum string value. - /// If true, ignore case; otherwise, regard case. + /// If , ignore case; otherwise, regard case. /// An object of type whose value is represented by . private static object ParseEnum(Type enumType, string value, bool ignoreCase) => Enum.Parse(enumType, value, ignoreCase); diff --git a/src/log4net/Util/PatternParser.cs b/src/log4net/Util/PatternParser.cs index 78241303..1066cde1 100644 --- a/src/log4net/Util/PatternParser.cs +++ b/src/log4net/Util/PatternParser.cs @@ -32,7 +32,7 @@ namespace log4net.Util; /// /// /// -/// The PatternParser processes a pattern string and +/// The processes a pattern string and /// returns a chain of objects. /// /// @@ -157,7 +157,7 @@ private void ParseInternal(string pattern, string[] matches) ProcessLiteral(pattern.Substring(offset, i - offset)); offset = i + 1; - var formattingInfo = new FormattingInfo(); + FormattingInfo formattingInfo = new(); // Process formatting options diff --git a/src/log4net/Util/PatternString.cs b/src/log4net/Util/PatternString.cs index 1dca01b9..9de37f22 100644 --- a/src/log4net/Util/PatternString.cs +++ b/src/log4net/Util/PatternString.cs @@ -37,7 +37,7 @@ namespace log4net.Util; /// /// This class functions similarly to the /// in that it accepts a pattern and renders it to a string. Unlike the -/// however the PatternString +/// however the /// does not render the properties of a specific but /// of the process in general. /// diff --git a/src/log4net/Util/PatternStringConverters/AppSettingPatternConverter.cs b/src/log4net/Util/PatternStringConverters/AppSettingPatternConverter.cs index df5801b0..cf4e28ab 100644 --- a/src/log4net/Util/PatternStringConverters/AppSettingPatternConverter.cs +++ b/src/log4net/Util/PatternStringConverters/AppSettingPatternConverter.cs @@ -85,7 +85,7 @@ private static IDictionary AppSettingsDictionary /// property. /// /// - /// If the is set to null + /// If the is set to /// then all the properties are written as key value pairs. /// /// diff --git a/src/log4net/Util/PatternStringConverters/PropertyPatternConverter.cs b/src/log4net/Util/PatternStringConverters/PropertyPatternConverter.cs index e29b665e..3d0c72c9 100644 --- a/src/log4net/Util/PatternStringConverters/PropertyPatternConverter.cs +++ b/src/log4net/Util/PatternStringConverters/PropertyPatternConverter.cs @@ -55,7 +55,7 @@ internal sealed class PropertyPatternConverter : PatternConverter /// property. /// /// - /// If the is set to null + /// If the is set to /// then all the properties are written as key value pairs. /// /// diff --git a/src/log4net/Util/PropertiesDictionary.cs b/src/log4net/Util/PropertiesDictionary.cs index d5e55937..476eaf5e 100644 --- a/src/log4net/Util/PropertiesDictionary.cs +++ b/src/log4net/Util/PropertiesDictionary.cs @@ -170,12 +170,12 @@ void IDictionary.Remove(object key) /// See /// /// - /// false + /// /// /// /// /// This collection is modifiable. This property always - /// returns false. + /// returns . /// /// bool IDictionary.IsReadOnly => false; diff --git a/src/log4net/Util/QuietTextWriter.cs b/src/log4net/Util/QuietTextWriter.cs index 283916a0..43ca5c39 100644 --- a/src/log4net/Util/QuietTextWriter.cs +++ b/src/log4net/Util/QuietTextWriter.cs @@ -72,7 +72,7 @@ public IErrorHandler ErrorHandler /// Gets a value indicating whether this writer is closed. /// /// - /// true if this writer is closed, otherwise false. + /// if this writer is closed, otherwise . /// /// /// diff --git a/src/log4net/Util/ReaderWriterLock.cs b/src/log4net/Util/ReaderWriterLock.cs index 75d5ba44..7fd52b4f 100644 --- a/src/log4net/Util/ReaderWriterLock.cs +++ b/src/log4net/Util/ReaderWriterLock.cs @@ -26,11 +26,11 @@ namespace log4net.Util; /// /// /// -/// ReaderWriterLock is used to synchronize access to a resource. +/// is used to synchronize access to a resource. /// At any given time, it allows either concurrent read access for /// multiple threads, or write access for a single thread. In a /// situation where a resource is changed infrequently, a -/// ReaderWriterLock provides better throughput than a simple +/// provides better throughput than a simple /// one-at-a-time lock, such as . /// /// diff --git a/src/log4net/Util/SystemInfo.cs b/src/log4net/Util/SystemInfo.cs index 30b23fdc..74f0f6be 100644 --- a/src/log4net/Util/SystemInfo.cs +++ b/src/log4net/Util/SystemInfo.cs @@ -300,11 +300,11 @@ public static string ApplicationFriendlyName public static DateTime ProcessStartTimeUtc { get; } = DateTime.UtcNow; /// - /// Text to output when a null is encountered. + /// Text to output when a is encountered. /// /// /// - /// Use this value to indicate a null has been encountered while + /// Use this value to indicate a has been encountered while /// outputting a string representation of an item. /// /// @@ -432,9 +432,9 @@ public static string AssemblyFileName(Assembly myAssembly) /// /// A sibling type to use to load the type. /// The name of the type to load. - /// Flag set to true to throw an exception if the type cannot be loaded. - /// true to ignore the case of the type name; otherwise, false - /// The type loaded or null if it could not be loaded. + /// Flag set to to throw an exception if the type cannot be loaded. + /// to ignore the case of the type name; otherwise, + /// The type loaded or if it could not be loaded. /// /// /// If the type name is fully qualified, i.e. if contains an assembly name in @@ -454,9 +454,9 @@ public static string AssemblyFileName(Assembly myAssembly) /// Loads the type specified in the type string. /// /// The name of the type to load. - /// Flag set to true to throw an exception if the type cannot be loaded. - /// true to ignore the case of the type name; otherwise, false - /// The type loaded or null if it could not be loaded. + /// Flag set to to throw an exception if the type cannot be loaded. + /// to ignore the case of the type name; otherwise, + /// The type loaded or if it could not be loaded. /// /// /// If the type name is fully qualified, i.e. if contains an assembly name in @@ -477,9 +477,9 @@ public static string AssemblyFileName(Assembly myAssembly) /// /// An assembly to load the type from. /// The name of the type to load. - /// Flag set to true to throw an exception if the type cannot be loaded. - /// true to ignore the case of the type name; otherwise, false - /// The type loaded or null if it could not be loaded. + /// Flag set to to throw an exception if the type cannot be loaded. + /// to ignore the case of the type name; otherwise, + /// The type loaded or if it could not be loaded. /// /// /// If the type name is fully qualified, i.e. if contains an assembly name in @@ -577,11 +577,11 @@ public static NotSupportedException CreateReadOnlyCollectionNotModifiableExcepti /// /// the string to parse /// out param where the parsed value is placed - /// true if the string was parsed into an integer + /// if the string was parsed into an integer /// /// /// Attempts to parse the string into an integer. If the string cannot - /// be parsed then this method returns false. The method does not throw an exception. + /// be parsed then this method returns . The method does not throw an exception. /// /// public static bool TryParse(string s, out int val) @@ -609,11 +609,11 @@ public static bool TryParse(string s, out int val) /// /// the string to parse /// out param where the parsed value is placed - /// true if the string was parsed into an integer + /// if the string was parsed into an integer /// /// /// Attempts to parse the string into an integer. If the string cannot - /// be parsed then this method returns false. The method does not throw an exception. + /// be parsed then this method returns . The method does not throw an exception. /// /// public static bool TryParse(string s, out long val) @@ -641,11 +641,11 @@ public static bool TryParse(string s, out long val) /// /// the string to parse /// out param where the parsed value is placed - /// true if the string was parsed into an integer + /// if the string was parsed into an integer /// /// /// Attempts to parse the string into an integer. If the string cannot - /// be parsed then this method returns false. The method does not throw an exception. + /// be parsed then this method returns . The method does not throw an exception. /// /// public static bool TryParse(string s, out short val) @@ -672,7 +672,7 @@ public static bool TryParse(string s, out short val) /// Lookup an application setting /// /// the application settings key to lookup - /// the value for the key, or null + /// the value for the key, or public static string? GetAppSetting(string key) { if (IsAndroid) @@ -750,13 +750,13 @@ public static string ConvertToFullPath(string path) /// /// /// If the platform permits, culture information is ignored completely (ordinal comparison). - /// The aim of this method is to provide a fast comparison that deals with null and ignores different casing. + /// The aim of this method is to provide a fast comparison that deals with and ignores different casing. /// It is not supposed to deal with various, culture-specific habits. /// Use it to compare against pure ASCII constants, like keywords etc. /// /// The one string. /// The other string. - /// true if the strings are equal, false otherwise. + /// if the strings are equal, otherwise. public static bool EqualsIgnoringCase(string? a, string? b) => string.Equals(a, b, StringComparison.OrdinalIgnoreCase); diff --git a/src/log4net/Util/SystemStringFormat.cs b/src/log4net/Util/SystemStringFormat.cs index 4b9644f1..d5f91a9b 100644 --- a/src/log4net/Util/SystemStringFormat.cs +++ b/src/log4net/Util/SystemStringFormat.cs @@ -99,7 +99,7 @@ private static string StringFormatError(Exception formatException, string? forma { try { - var buf = new StringBuilder("", 100); + StringBuilder buf = new("", 100); buf.Append("Exception during StringFormat: ").Append(formatException.Message); buf.Append(" ").Append(format).Append(""); buf.Append(""); diff --git a/src/log4net/Util/ThreadContextStack.cs b/src/log4net/Util/ThreadContextStack.cs index 23a31feb..774cfc96 100644 --- a/src/log4net/Util/ThreadContextStack.cs +++ b/src/log4net/Util/ThreadContextStack.cs @@ -117,11 +117,11 @@ internal ThreadContextStack() /// /// Pushes a new context onto this stack. An /// is returned that can be used to clean up this stack. This - /// can be easily combined with the using keyword to scope the + /// can be easily combined with the keyword to scope the /// context. /// /// - /// Simple example of using the Push method with the using keyword. + /// Simple example of using the method with the keyword. /// /// using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message")) /// { diff --git a/src/log4net/Util/TypeConverters/BooleanConverter.cs b/src/log4net/Util/TypeConverters/BooleanConverter.cs index d90556a6..53d853a1 100644 --- a/src/log4net/Util/TypeConverters/BooleanConverter.cs +++ b/src/log4net/Util/TypeConverters/BooleanConverter.cs @@ -27,7 +27,7 @@ namespace log4net.Util.TypeConverters; /// /// /// -/// Supports conversion from string to bool type. +/// Supports conversion from string to type. /// /// /// @@ -43,7 +43,7 @@ internal sealed class BooleanConverter : IConvertFrom /// /// the type to convert /// - /// True if the is + /// if the is /// the type. /// public bool CanConvertFrom(Type sourceType) => sourceType == typeof(string); diff --git a/src/log4net/Util/TypeConverters/ConverterRegistry.cs b/src/log4net/Util/TypeConverters/ConverterRegistry.cs index 82eb0140..03259584 100644 --- a/src/log4net/Util/TypeConverters/ConverterRegistry.cs +++ b/src/log4net/Util/TypeConverters/ConverterRegistry.cs @@ -91,7 +91,7 @@ public static void AddConverter(Type destinationType, Type converterType) /// The type being converted from. /// The type being converted to. /// - /// The type converter instance to use for type conversions or null + /// The type converter instance to use for type conversions or /// if no type converter is found. /// public static IConvertTo? GetConvertTo(Type sourceType, Type destinationType) @@ -121,7 +121,7 @@ public static void AddConverter(Type destinationType, Type converterType) /// /// The type being converted to. /// - /// The type converter instance to use for type conversions or null + /// The type converter instance to use for type conversions or /// if no type converter is found. /// public static IConvertFrom? GetConvertFrom(Type destinationType) @@ -150,7 +150,7 @@ public static void AddConverter(Type destinationType, Type converterType) /// /// The type being converted to. /// - /// The type converter instance to use for type conversions or null + /// The type converter instance to use for type conversions or /// if no type converter is found. /// private static object? GetConverterFromAttribute(Type destinationType) @@ -177,7 +177,7 @@ public static void AddConverter(Type destinationType, Type converterType) /// /// The type of the type converter. /// - /// The type converter instance to use for type conversions or null + /// The type converter instance to use for type conversions or /// if no type converter is found. /// /// diff --git a/src/log4net/Util/TypeConverters/EncodingConverter.cs b/src/log4net/Util/TypeConverters/EncodingConverter.cs index 9042a64b..8ddcf5b3 100644 --- a/src/log4net/Util/TypeConverters/EncodingConverter.cs +++ b/src/log4net/Util/TypeConverters/EncodingConverter.cs @@ -39,7 +39,7 @@ internal sealed class EncodingConverter : IConvertFrom /// /// the type to convert /// - /// True if the is + /// if the is /// the type. /// public bool CanConvertFrom(Type sourceType) => sourceType == typeof(string); diff --git a/src/log4net/Util/TypeConverters/IPAddressConverter.cs b/src/log4net/Util/TypeConverters/IPAddressConverter.cs index 7054b1c2..bbfab91d 100644 --- a/src/log4net/Util/TypeConverters/IPAddressConverter.cs +++ b/src/log4net/Util/TypeConverters/IPAddressConverter.cs @@ -45,7 +45,7 @@ internal sealed class IpAddressConverter : IConvertFrom /// true if the conversion is possible /// /// - /// Returns true if the is + /// Returns if the is /// the type. /// /// diff --git a/src/log4net/Util/TypeConverters/PatternLayoutConverter.cs b/src/log4net/Util/TypeConverters/PatternLayoutConverter.cs index 26c8c263..557b57eb 100644 --- a/src/log4net/Util/TypeConverters/PatternLayoutConverter.cs +++ b/src/log4net/Util/TypeConverters/PatternLayoutConverter.cs @@ -43,7 +43,7 @@ internal sealed class PatternLayoutConverter : IConvertFrom /// /// the type to convert /// - /// True if the is + /// if the is /// the type. /// public bool CanConvertFrom(System.Type sourceType) => sourceType == typeof(string); diff --git a/src/log4net/Util/TypeConverters/PatternStringConverter.cs b/src/log4net/Util/TypeConverters/PatternStringConverter.cs index d3ccba1b..7af6687c 100644 --- a/src/log4net/Util/TypeConverters/PatternStringConverter.cs +++ b/src/log4net/Util/TypeConverters/PatternStringConverter.cs @@ -49,7 +49,7 @@ internal sealed class PatternStringConverter : IConvertTo, IConvertFrom /// true if the conversion is possible /// /// - /// Returns true if the is + /// Returns if the is /// assignable from a type. /// /// @@ -86,7 +86,7 @@ public object ConvertTo(object source, Type targetType) /// /// the type to convert /// - /// True if the is + /// if the is /// the type. /// public bool CanConvertFrom(System.Type sourceType) => sourceType == typeof(string); diff --git a/src/log4net/Util/TypeConverters/TypeConverter.cs b/src/log4net/Util/TypeConverters/TypeConverter.cs index 968df5fc..356bb77e 100644 --- a/src/log4net/Util/TypeConverters/TypeConverter.cs +++ b/src/log4net/Util/TypeConverters/TypeConverter.cs @@ -37,7 +37,7 @@ internal sealed class TypeConverter : IConvertFrom /// /// the type to convert /// - /// True if the is + /// if the is /// the type. /// public bool CanConvertFrom(Type sourceType) => sourceType == typeof(string); diff --git a/src/log4net/Util/TypeConverters/TypeConverterAttribute.cs b/src/log4net/Util/TypeConverters/TypeConverterAttribute.cs index 42860a0f..a71a363f 100644 --- a/src/log4net/Util/TypeConverters/TypeConverterAttribute.cs +++ b/src/log4net/Util/TypeConverters/TypeConverterAttribute.cs @@ -31,7 +31,7 @@ namespace log4net.Util.TypeConverters; /// /// /// To associate a type converter with a target type apply a -/// TypeConverterAttribute to the target type. Specify the +/// to the target type. Specify the /// type of the type converter on the attribute. /// /// From ee9e87862ee64942dd0fd87e6fa01fc2cdf93446 Mon Sep 17 00:00:00 2001 From: Jan Friedrich Date: Fri, 20 Feb 2026 16:00:36 +0100 Subject: [PATCH 2/2] #281 simplify type names --- src/log4net/Appender/AdoNetAppender.cs | 14 +++++----- .../Appender/ColoredConsoleAppender.cs | 2 +- src/log4net/Appender/DebugAppender.cs | 2 +- src/log4net/Appender/IFlushable.cs | 2 +- .../Appender/Internal/UdpConnection.cs | 2 +- src/log4net/Appender/LocalSyslogAppender.cs | 2 +- .../Appender/ManagedColoredConsoleAppender.cs | 2 +- src/log4net/Appender/TextWriterAppender.cs | 6 ++--- src/log4net/Config/BasicConfigurator.cs | 4 +-- src/log4net/Config/RepositoryAttribute.cs | 4 +-- src/log4net/Config/XmlConfigurator.cs | 4 +-- .../Config/XmlConfiguratorAttribute.cs | 2 +- src/log4net/Core/IFixingRequired.cs | 8 +++--- src/log4net/Core/Level.cs | 14 +++++----- src/log4net/Core/LevelMap.cs | 2 +- src/log4net/Core/LocationInfo.cs | 2 +- src/log4net/Core/LogImpl.cs | 2 +- src/log4net/Core/LoggerManager.cs | 2 +- src/log4net/Core/LoggingEvent.cs | 2 +- src/log4net/Core/SecurityContextProvider.cs | 4 +-- src/log4net/Filter/FilterSkeleton.cs | 4 +-- src/log4net/Filter/IFilter.cs | 4 +-- src/log4net/GlobalContext.cs | 2 +- src/log4net/ILog.cs | 26 +++++++++---------- src/log4net/Layout/ExceptionLayout.cs | 2 +- .../Pattern/AspNetCachePatternConverter.cs | 2 +- .../Pattern/AspNetContextPatternConverter.cs | 2 +- .../Pattern/AspNetRequestPatternConverter.cs | 2 +- .../Pattern/AspNetSessionPatternConverter.cs | 2 +- .../Layout/Pattern/DatePatternConverter.cs | 2 +- src/log4net/Layout/PatternLayout.cs | 18 ++++++------- src/log4net/LogManager.cs | 8 +++--- src/log4net/Plugin/IPlugin.cs | 4 +-- .../IBasicRepositoryConfigurator.cs | 4 +-- src/log4net/Repository/ILoggerRepository.cs | 2 +- .../Repository/IXmlRepositoryConfigurator.cs | 2 +- .../Repository/LoggerRepositorySkeleton.cs | 4 +-- src/log4net/ThreadContext.cs | 2 +- src/log4net/Util/EmptyDictionary.cs | 2 +- src/log4net/Util/GlobalContextProperties.cs | 2 +- src/log4net/Util/ILogExtensions.cs | 20 +++++++------- .../Util/LogicalThreadContextProperties.cs | 4 +-- src/log4net/Util/OnlyOnceErrorHandler.cs | 2 +- src/log4net/Util/PatternString.cs | 22 ++++++++-------- .../AppSettingPatternConverter.cs | 4 +-- .../DatePatternConverter.cs | 2 +- .../EnvironmentFolderPathPatternConverter.cs | 10 +++---- .../EnvironmentPatternConverter.cs | 4 +-- .../LiteralPatternConverter.cs | 4 +-- .../PropertyPatternConverter.cs | 4 +-- src/log4net/Util/ReaderWriterLock.cs | 2 +- src/log4net/Util/SystemStringFormat.cs | 4 +-- src/log4net/Util/ThreadContextProperties.cs | 2 +- src/log4net/Util/ThreadContextStack.cs | 6 ++--- src/log4net/Util/ThreadContextStacks.cs | 2 +- .../TypeConverters/PatternStringConverter.cs | 2 +- src/log4net/Util/WindowsSecurityContext.cs | 4 +-- 57 files changed, 138 insertions(+), 138 deletions(-) diff --git a/src/log4net/Appender/AdoNetAppender.cs b/src/log4net/Appender/AdoNetAppender.cs index fa4d90cc..65d3e546 100644 --- a/src/log4net/Appender/AdoNetAppender.cs +++ b/src/log4net/Appender/AdoNetAppender.cs @@ -44,8 +44,8 @@ namespace log4net.Appender; /// /// Records are written into the database either using a prepared /// statement or a stored procedure. The property -/// is set to (System.Data.CommandType.Text) to specify a prepared statement -/// or to (System.Data.CommandType.StoredProcedure) to specify a stored +/// is set to (System.Data.CommandType.Text) to specify a prepared statement +/// or to (System.Data.CommandType.StoredProcedure) to specify a stored /// procedure. /// /// @@ -254,14 +254,14 @@ public AdoNetAppender() /// /// /// - /// This value may be either (System.Data.CommandType.Text) to specify + /// This value may be either (System.Data.CommandType.Text) to specify /// that the is a prepared statement to execute, - /// or (System.Data.CommandType.StoredProcedure) to specify that the + /// or (System.Data.CommandType.StoredProcedure) to specify that the /// property is the name of a stored procedure /// to execute. /// /// - /// The default value is (System.Data.CommandType.Text). + /// The default value is (System.Data.CommandType.Text). /// /// public CommandType CommandType { get; set; } @@ -550,7 +550,7 @@ protected virtual void Prepare(IDbCommand dbCmd) /// more control over the format of the database statement. /// /// - /// Text that can be passed to a . + /// Text that can be passed to a . /// protected virtual string GetLogStatement(LoggingEvent logEvent) { @@ -742,7 +742,7 @@ private void DisposeConnection() /// /// /// This class provides the basic database parameter properties -/// as defined by the interface. +/// as defined by the interface. /// /// This type can be subclassed to provide database specific /// functionality. The two methods that are called externally are diff --git a/src/log4net/Appender/ColoredConsoleAppender.cs b/src/log4net/Appender/ColoredConsoleAppender.cs index 65fbd484..58dd8e41 100644 --- a/src/log4net/Appender/ColoredConsoleAppender.cs +++ b/src/log4net/Appender/ColoredConsoleAppender.cs @@ -181,7 +181,7 @@ public virtual string Target public void AddMapping(LevelColors mapping) => _levelMapping.Add(mapping); /// - /// This method is called by the method. + /// This method is called by the method. /// /// The event to log. /// diff --git a/src/log4net/Appender/DebugAppender.cs b/src/log4net/Appender/DebugAppender.cs index 41bcbc73..02ab3ed8 100644 --- a/src/log4net/Appender/DebugAppender.cs +++ b/src/log4net/Appender/DebugAppender.cs @@ -67,7 +67,7 @@ public class DebugAppender : AppenderSkeleton /// /// /// - /// Defaults to a with %logger as the pattern which will use the logger name of the current + /// Defaults to a with %logger as the pattern which will use the logger name of the current /// as the category parameter. /// /// diff --git a/src/log4net/Appender/IFlushable.cs b/src/log4net/Appender/IFlushable.cs index ac2c5de3..c31ca16c 100644 --- a/src/log4net/Appender/IFlushable.cs +++ b/src/log4net/Appender/IFlushable.cs @@ -29,7 +29,7 @@ public interface IFlushable /// /// /// Appenders that implement the method must do so in a thread-safe manner: it can be called concurrently with - /// the method. + /// the method. /// /// Typically this is done by locking on the Appender instance, e.g.: /// diff --git a/src/log4net/Appender/Internal/UdpConnection.cs b/src/log4net/Appender/Internal/UdpConnection.cs index d39cd536..e349858e 100644 --- a/src/log4net/Appender/Internal/UdpConnection.cs +++ b/src/log4net/Appender/Internal/UdpConnection.cs @@ -51,7 +51,7 @@ public void Connect(int localPort, IPAddress remoteAddress, int remotePort) /// Creates a new instance configured with the specified local port and remote address. /// /// A instance configured with the specified parameters. - internal static UdpClient CreateClient(int localPort, System.Net.IPAddress remoteAddress) + internal static UdpClient CreateClient(int localPort, IPAddress remoteAddress) => localPort == 0 ? new (remoteAddress.AddressFamily) : new (localPort, remoteAddress.AddressFamily); diff --git a/src/log4net/Appender/LocalSyslogAppender.cs b/src/log4net/Appender/LocalSyslogAppender.cs index 1cd66330..df481c46 100644 --- a/src/log4net/Appender/LocalSyslogAppender.cs +++ b/src/log4net/Appender/LocalSyslogAppender.cs @@ -66,7 +66,7 @@ public class LocalSyslogAppender : AppenderSkeleton /// /// /// The log4net Level maps to a syslog severity using the - /// method and the + /// method and the /// class. The severity is set on . /// /// diff --git a/src/log4net/Appender/ManagedColoredConsoleAppender.cs b/src/log4net/Appender/ManagedColoredConsoleAppender.cs index e35bb020..31d79233 100644 --- a/src/log4net/Appender/ManagedColoredConsoleAppender.cs +++ b/src/log4net/Appender/ManagedColoredConsoleAppender.cs @@ -122,7 +122,7 @@ public virtual string Target /// The event to log. /// /// - /// This method is called by the method. + /// This method is called by the method. /// /// /// The format of the output will depend on the appender's layout. diff --git a/src/log4net/Appender/TextWriterAppender.cs b/src/log4net/Appender/TextWriterAppender.cs index 3321b152..046476c5 100644 --- a/src/log4net/Appender/TextWriterAppender.cs +++ b/src/log4net/Appender/TextWriterAppender.cs @@ -343,15 +343,15 @@ protected virtual void PrepareWriter() } /// - /// Gets or sets the where logging events + /// Gets or sets the where logging events /// will be written to. /// /// - /// The where logging events are written. + /// The where logging events are written. /// /// /// - /// This is the where logging events + /// This is the where logging events /// will be written to. /// /// diff --git a/src/log4net/Config/BasicConfigurator.cs b/src/log4net/Config/BasicConfigurator.cs index 6c035c48..ea7dfa68 100644 --- a/src/log4net/Config/BasicConfigurator.cs +++ b/src/log4net/Config/BasicConfigurator.cs @@ -43,8 +43,8 @@ namespace log4net.Config; /// events will be delivered to that appender. /// /// -/// Appenders can also implement the interface. Therefore -/// they would require that the method +/// Appenders can also implement the interface. Therefore +/// they would require that the method /// be called after the appenders properties have been configured. /// /// diff --git a/src/log4net/Config/RepositoryAttribute.cs b/src/log4net/Config/RepositoryAttribute.cs index ab530bca..fd5c6308 100644 --- a/src/log4net/Config/RepositoryAttribute.cs +++ b/src/log4net/Config/RepositoryAttribute.cs @@ -30,7 +30,7 @@ namespace log4net.Config; /// on the assembly controls /// the configuration of the repository. The property specifies the name /// of the repository that this assembly is a part of. The -/// specifies the type of the object +/// specifies the type of the object /// to create for the assembly. If this attribute is not specified or a /// is not specified then the assembly will be part of the default shared logging repository. /// @@ -93,7 +93,7 @@ public RepositoryAttribute() /// /// /// The type of the repository to create for the assembly. - /// The type must implement the + /// The type must implement the /// interface. /// /// diff --git a/src/log4net/Config/XmlConfigurator.cs b/src/log4net/Config/XmlConfigurator.cs index c2fd8405..fa060cb1 100644 --- a/src/log4net/Config/XmlConfigurator.cs +++ b/src/log4net/Config/XmlConfigurator.cs @@ -241,7 +241,7 @@ public static ICollection Configure(FileInfo configFile) /// the log4net configuration data. /// /// - /// The must support the URI scheme specified. + /// The must support the URI scheme specified. /// /// public static ICollection Configure(Uri configUri) @@ -454,7 +454,7 @@ private static void InternalConfigure(ILoggerRepository repository, FileInfo? co /// the configuration data. /// /// - /// The must support the URI scheme specified. + /// The must support the URI scheme specified. /// /// public static ICollection Configure(ILoggerRepository repository, Uri configUri) diff --git a/src/log4net/Config/XmlConfiguratorAttribute.cs b/src/log4net/Config/XmlConfiguratorAttribute.cs index 0f3af574..c07dfbab 100644 --- a/src/log4net/Config/XmlConfiguratorAttribute.cs +++ b/src/log4net/Config/XmlConfiguratorAttribute.cs @@ -63,7 +63,7 @@ namespace log4net.Config; /// Log4net will only look for assembly level configuration attributes once. /// When using the log4net assembly level attributes to control the configuration /// of log4net you must ensure that the first call to any of the -/// methods is made from the assembly with the configuration +/// methods is made from the assembly with the configuration /// attributes. /// /// diff --git a/src/log4net/Core/IFixingRequired.cs b/src/log4net/Core/IFixingRequired.cs index 2dad762f..b25b3984 100644 --- a/src/log4net/Core/IFixingRequired.cs +++ b/src/log4net/Core/IFixingRequired.cs @@ -26,13 +26,13 @@ namespace log4net.Core; /// /// Interface that indicates that the object requires fixing before it /// can be taken outside the context of the appender's -/// method. +/// method. /// /// /// When objects that implement this interface are stored -/// in the context properties maps -/// and -/// are fixed +/// in the context properties maps +/// and +/// are fixed /// (see ) the /// method will be called. /// diff --git a/src/log4net/Core/Level.cs b/src/log4net/Core/Level.cs index 6023176c..56ec20b5 100644 --- a/src/log4net/Core/Level.cs +++ b/src/log4net/Core/Level.cs @@ -32,20 +32,20 @@ namespace log4net.Core; /// Each has an associated . /// /// -/// Levels have a numeric that defines the relative -/// ordering between levels. Two Levels with the same +/// Levels have a numeric that defines the relative +/// ordering between levels. Two Levels with the same /// are deemed to be equivalent. /// /// -/// The levels that are recognized by log4net are set for each +/// The levels that are recognized by log4net are set for each /// and each repository can have different levels defined. The levels are stored -/// in the on the repository. Levels are -/// looked up by name from the . +/// in the on the repository. Levels are +/// looked up by name from the . /// /// -/// When logging at level INFO the actual level used is not but +/// When logging at level INFO the actual level used is not but /// the value of LoggerRepository.LevelMap["INFO"]. The default value for this is -/// , but this can be changed by reconfiguring the level map. +/// , but this can be changed by reconfiguring the level map. /// /// /// Each level has a in addition to its . The diff --git a/src/log4net/Core/LevelMap.cs b/src/log4net/Core/LevelMap.cs index a72c7e04..f5d3e5fb 100644 --- a/src/log4net/Core/LevelMap.cs +++ b/src/log4net/Core/LevelMap.cs @@ -28,7 +28,7 @@ namespace log4net.Core; /// /// /// -/// This mapping is held separately for each . +/// This mapping is held separately for each . /// The level name is case-insensitive. /// /// diff --git a/src/log4net/Core/LocationInfo.cs b/src/log4net/Core/LocationInfo.cs index 963797f1..32e7d1f0 100644 --- a/src/log4net/Core/LocationInfo.cs +++ b/src/log4net/Core/LocationInfo.cs @@ -144,7 +144,7 @@ public LocationInfo(Type? callerStackBoundaryDeclaringType) } } } - catch (System.Security.SecurityException) + catch (SecurityException) { // This security exception will occur if the caller does not have // some undefined set of SecurityPermission flags. diff --git a/src/log4net/Core/LogImpl.cs b/src/log4net/Core/LogImpl.cs index 383c1948..7ea86025 100644 --- a/src/log4net/Core/LogImpl.cs +++ b/src/log4net/Core/LogImpl.cs @@ -1175,7 +1175,7 @@ public virtual void FatalFormat(IFormatProvider? provider, string format, params /// the other hand, if the log is debug enabled, you /// will incur the cost of evaluating whether the logger is debug /// enabled twice. Once in and once in - /// the . This is an insignificant overhead + /// the . This is an insignificant overhead /// since evaluating a logger takes about 1% of the time it /// takes to actually log. /// diff --git a/src/log4net/Core/LoggerManager.cs b/src/log4net/Core/LoggerManager.cs index 8e6917f3..3ef05795 100644 --- a/src/log4net/Core/LoggerManager.cs +++ b/src/log4net/Core/LoggerManager.cs @@ -440,7 +440,7 @@ public static void ResetConfiguration(Assembly repositoryAssembly) /// /// /// Creates the default type of which is a - /// object. + /// object. /// /// /// The name must be unique. Repositories cannot be redefined. diff --git a/src/log4net/Core/LoggingEvent.cs b/src/log4net/Core/LoggingEvent.cs index cdc13465..d915f69c 100644 --- a/src/log4net/Core/LoggingEvent.cs +++ b/src/log4net/Core/LoggingEvent.cs @@ -944,7 +944,7 @@ public FixFlags Fix /// /// /// The property must be set during the - /// method call if this event + /// method call if this event /// is to be used outside that method. /// /// diff --git a/src/log4net/Core/SecurityContextProvider.cs b/src/log4net/Core/SecurityContextProvider.cs index 9dbc9046..b0718e18 100644 --- a/src/log4net/Core/SecurityContextProvider.cs +++ b/src/log4net/Core/SecurityContextProvider.cs @@ -33,7 +33,7 @@ namespace log4net.Core; /// will request one from this . /// /// -/// By default the is +/// By default the is /// an instance of which returns only /// objects. This is a reasonable default /// where the privileges required are not know by the system. @@ -43,7 +43,7 @@ namespace log4net.Core; /// and overriding the method to return /// the desired objects. The default provider /// can be replaced by programmatically setting the value of the -/// property. +/// property. /// /// /// An alternative is to use the log4net.Config.SecurityContextProviderAttribute diff --git a/src/log4net/Filter/FilterSkeleton.cs b/src/log4net/Filter/FilterSkeleton.cs index e6a9e27d..ab230241 100644 --- a/src/log4net/Filter/FilterSkeleton.cs +++ b/src/log4net/Filter/FilterSkeleton.cs @@ -27,8 +27,8 @@ namespace log4net.Filter; /// /// /// Users should extend this class to implement customized logging -/// event filtering. Note that and -/// , the parent class of all standard +/// event filtering. Note that and +/// , the parent class of all standard /// appenders, have built-in filtering rules. It is suggested that you /// first use and understand the built-in rules before rushing to write /// your own custom filters. diff --git a/src/log4net/Filter/IFilter.cs b/src/log4net/Filter/IFilter.cs index 289739a9..69c0cd0a 100644 --- a/src/log4net/Filter/IFilter.cs +++ b/src/log4net/Filter/IFilter.cs @@ -27,8 +27,8 @@ namespace log4net.Filter; /// /// /// Users should implement this interface to implement customized logging -/// event filtering. Note that and -/// , the parent class of all standard +/// event filtering. Note that and +/// , the parent class of all standard /// appenders, have built-in filtering rules. It is suggested that you /// first use and understand the built-in rules before rushing to write /// your own custom filters. diff --git a/src/log4net/GlobalContext.cs b/src/log4net/GlobalContext.cs index 01521752..a41eb049 100644 --- a/src/log4net/GlobalContext.cs +++ b/src/log4net/GlobalContext.cs @@ -31,7 +31,7 @@ namespace log4net; /// /// /// The global context has a properties map and these properties can -/// be included in the output of log messages. The +/// be included in the output of log messages. The /// supports selecting and outputing these properties. /// /// diff --git a/src/log4net/ILog.cs b/src/log4net/ILog.cs index 5d172ecf..56c350bc 100644 --- a/src/log4net/ILog.cs +++ b/src/log4net/ILog.cs @@ -77,7 +77,7 @@ public interface ILog : ILoggerWrapper /// level. If this logger is /// DEBUG enabled, then it converts the message object /// (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -229,7 +229,7 @@ public interface ILog : ILoggerWrapper /// level. If this logger is /// INFO enabled, then it converts the message object /// (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of the /// additivity flag. @@ -382,7 +382,7 @@ public interface ILog : ILoggerWrapper /// level. If this logger is /// WARN enabled, then it converts the message object /// (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of the /// additivity flag. @@ -536,7 +536,7 @@ public interface ILog : ILoggerWrapper /// level. If this logger is /// ERROR enabled, then it converts the message object /// (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of the /// additivity flag. @@ -688,7 +688,7 @@ public interface ILog : ILoggerWrapper /// level. If this logger is /// FATAL enabled, then it converts the message object /// (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of the /// additivity flag. @@ -908,11 +908,11 @@ public interface ILog : ILoggerWrapper /// if this logger is enabled for events, otherwise. /// /// - /// For more information see . + /// For more information see . /// /// /// - /// + /// bool IsInfoEnabled { get; } /// @@ -922,11 +922,11 @@ public interface ILog : ILoggerWrapper /// if this logger is enabled for events, otherwise. /// /// - /// For more information see . + /// For more information see . /// /// /// - /// + /// bool IsWarnEnabled { get; } /// @@ -936,11 +936,11 @@ public interface ILog : ILoggerWrapper /// if this logger is enabled for events, otherwise. /// /// - /// For more information see . + /// For more information see . /// /// /// - /// + /// bool IsErrorEnabled { get; } /// @@ -950,10 +950,10 @@ public interface ILog : ILoggerWrapper /// if this logger is enabled for events, otherwise. /// /// - /// For more information see . + /// For more information see . /// /// /// - /// + /// bool IsFatalEnabled { get; } } diff --git a/src/log4net/Layout/ExceptionLayout.cs b/src/log4net/Layout/ExceptionLayout.cs index ea6bab94..af0f4019 100644 --- a/src/log4net/Layout/ExceptionLayout.cs +++ b/src/log4net/Layout/ExceptionLayout.cs @@ -31,7 +31,7 @@ namespace log4net.Layout; /// /// /// This Layout should only be used with appenders that utilize multiple -/// layouts (e.g. ). +/// layouts (e.g. ). /// /// /// Nicko Cadell diff --git a/src/log4net/Layout/Pattern/AspNetCachePatternConverter.cs b/src/log4net/Layout/Pattern/AspNetCachePatternConverter.cs index ad5bc7e1..089769fd 100644 --- a/src/log4net/Layout/Pattern/AspNetCachePatternConverter.cs +++ b/src/log4net/Layout/Pattern/AspNetCachePatternConverter.cs @@ -47,7 +47,7 @@ internal sealed class AspNetCachePatternConverter : AspNetPatternLayoutConverter /// /// /// Writes out the value of a named property. The property name - /// should be set in the + /// should be set in the /// property. If no property has been set, all key value pairs from the Cache will /// be written to the output. /// diff --git a/src/log4net/Layout/Pattern/AspNetContextPatternConverter.cs b/src/log4net/Layout/Pattern/AspNetContextPatternConverter.cs index af86b9f2..a9e5edde 100644 --- a/src/log4net/Layout/Pattern/AspNetContextPatternConverter.cs +++ b/src/log4net/Layout/Pattern/AspNetContextPatternConverter.cs @@ -46,7 +46,7 @@ internal sealed class AspNetContextPatternConverter : AspNetPatternLayoutConvert /// /// /// Writes out the value of a named property. The property name - /// should be set in the + /// should be set in the /// property. /// /// diff --git a/src/log4net/Layout/Pattern/AspNetRequestPatternConverter.cs b/src/log4net/Layout/Pattern/AspNetRequestPatternConverter.cs index b82f9410..881911fa 100644 --- a/src/log4net/Layout/Pattern/AspNetRequestPatternConverter.cs +++ b/src/log4net/Layout/Pattern/AspNetRequestPatternConverter.cs @@ -47,7 +47,7 @@ internal sealed class AspNetRequestPatternConverter : AspNetPatternLayoutConvert /// /// /// Writes out the value of a named property. The property name - /// should be set in the + /// should be set in the /// property. /// /// diff --git a/src/log4net/Layout/Pattern/AspNetSessionPatternConverter.cs b/src/log4net/Layout/Pattern/AspNetSessionPatternConverter.cs index 962a9980..f3b6f24d 100644 --- a/src/log4net/Layout/Pattern/AspNetSessionPatternConverter.cs +++ b/src/log4net/Layout/Pattern/AspNetSessionPatternConverter.cs @@ -47,7 +47,7 @@ internal sealed class AspNetSessionPatternConverter : AspNetPatternLayoutConvert /// /// /// Writes out the value of a named property. The property name - /// should be set in the + /// should be set in the /// property. If no property has been set, all key value pairs from the Session will /// be written to the output. /// diff --git a/src/log4net/Layout/Pattern/DatePatternConverter.cs b/src/log4net/Layout/Pattern/DatePatternConverter.cs index 4cbe21d5..5c325138 100644 --- a/src/log4net/Layout/Pattern/DatePatternConverter.cs +++ b/src/log4net/Layout/Pattern/DatePatternConverter.cs @@ -35,7 +35,7 @@ namespace log4net.Layout.Pattern; /// Render the to the writer as a string. /// /// -/// The value of the determines +/// The value of the determines /// the formatting of the date. The following values are allowed: /// /// diff --git a/src/log4net/Layout/PatternLayout.cs b/src/log4net/Layout/PatternLayout.cs index eaf8f88e..7f8b2dca 100644 --- a/src/log4net/Layout/PatternLayout.cs +++ b/src/log4net/Layout/PatternLayout.cs @@ -39,7 +39,7 @@ namespace log4net.Layout; /// /// /// -/// The goal of this class is to a +/// The goal of this class is to a /// as a string. The results /// depend on the conversion pattern. /// @@ -174,7 +174,7 @@ namespace log4net.Layout; /// between braces. For example, %date{HH:mm:ss,fff} or /// %date{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is /// given then ISO8601 format is -/// assumed (). +/// assumed (). /// /// /// The date format specifier admits the same syntax as the @@ -184,9 +184,9 @@ namespace log4net.Layout; /// For better results it is recommended to use the log4net date /// formatters. These can be specified using one of the strings /// "ABSOLUTE", "DATE" and "ISO8601" for specifying -/// , -/// and respectively -/// . For example, +/// , +/// and respectively +/// . For example, /// %date{ISO8601} or %date{ABSOLUTE}. /// /// @@ -571,7 +571,7 @@ namespace log4net.Layout; /// between braces. For example, %utcdate{HH:mm:ss,fff} or /// %utcdate{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is /// given then ISO8601 format is -/// assumed (). +/// assumed (). /// /// /// The date format specifier admits the same syntax as the @@ -581,9 +581,9 @@ namespace log4net.Layout; /// For better results it is recommended to use the log4net date /// formatters. These can be specified using one of the strings /// "ABSOLUTE", "DATE" and "ISO8601" for specifying -/// , -/// and respectively -/// . For example, +/// , +/// and respectively +/// . For example, /// %utcdate{ISO8601} or %utcdate{ABSOLUTE}. /// /// diff --git a/src/log4net/LogManager.cs b/src/log4net/LogManager.cs index 2538b775..cc255a54 100644 --- a/src/log4net/LogManager.cs +++ b/src/log4net/LogManager.cs @@ -203,7 +203,7 @@ public static ILog GetLogger(Assembly repositoryAssembly, string name) => WrapLogger(LoggerManager.GetLogger(repositoryAssembly, name))!; /// - /// Shorthand for . + /// Shorthand for . /// /// /// Get the logger for the fully qualified name of the type specified. @@ -214,7 +214,7 @@ public static ILog GetLogger(Type type) => GetLogger(Assembly.GetCallingAssembly(), type.EnsureNotNull().FullName!); /// - /// Shorthand for . + /// Shorthand for . /// /// /// Gets the logger for the fully qualified name of the type specified. @@ -226,7 +226,7 @@ public static ILog GetLogger(string repository, Type type) => WrapLogger(LoggerManager.GetLogger(repository, type))!; /// - /// Shorthand for . + /// Shorthand for . /// /// /// Gets the logger for the fully qualified name of the type specified. @@ -435,7 +435,7 @@ public static ILog GetLogger(Assembly repositoryAssembly, Type type) /// /// /// Creates the default type of which is a - /// object. + /// object. /// /// /// The name must be unique. Repositories cannot be redefined. diff --git a/src/log4net/Plugin/IPlugin.cs b/src/log4net/Plugin/IPlugin.cs index 621f741c..b07c08e9 100644 --- a/src/log4net/Plugin/IPlugin.cs +++ b/src/log4net/Plugin/IPlugin.cs @@ -27,8 +27,8 @@ namespace log4net.Plugin; /// /// /// Plugins define additional behavior that can be associated -/// with a . -/// The held by the +/// with a . +/// The held by the /// property is used to store the plugins for a repository. /// /// diff --git a/src/log4net/Repository/IBasicRepositoryConfigurator.cs b/src/log4net/Repository/IBasicRepositoryConfigurator.cs index 221b99c7..e41f7421 100644 --- a/src/log4net/Repository/IBasicRepositoryConfigurator.cs +++ b/src/log4net/Repository/IBasicRepositoryConfigurator.cs @@ -25,11 +25,11 @@ namespace log4net.Repository; /// /// /// Interface used by basic configurator to configure a -/// with a default . +/// with a default . /// /// /// A should implement this interface to support -/// configuration by the . +/// configuration by the . /// /// /// Nicko Cadell diff --git a/src/log4net/Repository/ILoggerRepository.cs b/src/log4net/Repository/ILoggerRepository.cs index 1f99ae14..12f74b45 100644 --- a/src/log4net/Repository/ILoggerRepository.cs +++ b/src/log4net/Repository/ILoggerRepository.cs @@ -155,7 +155,7 @@ public interface ILoggerRepository /// This method should not normally be used to log. /// The interface should be used /// for routine logging. This interface can be obtained - /// using the method. + /// using the method. /// /// /// The logEvent is delivered to the appropriate logger and diff --git a/src/log4net/Repository/IXmlRepositoryConfigurator.cs b/src/log4net/Repository/IXmlRepositoryConfigurator.cs index c4e0aaf1..004f98f4 100644 --- a/src/log4net/Repository/IXmlRepositoryConfigurator.cs +++ b/src/log4net/Repository/IXmlRepositoryConfigurator.cs @@ -28,7 +28,7 @@ namespace log4net.Repository; /// /// /// A should implement this interface to support -/// configuration by the . +/// configuration by the . /// /// /// Nicko Cadell diff --git a/src/log4net/Repository/LoggerRepositorySkeleton.cs b/src/log4net/Repository/LoggerRepositorySkeleton.cs index ce142330..82e32e1e 100644 --- a/src/log4net/Repository/LoggerRepositorySkeleton.cs +++ b/src/log4net/Repository/LoggerRepositorySkeleton.cs @@ -272,7 +272,7 @@ public virtual void ResetConfiguration() /// This method should not normally be used to log. /// The interface should be used /// for routine logging. This interface can be obtained - /// using the method. + /// using the method. /// /// /// The logEvent is delivered to the appropriate logger and @@ -470,7 +470,7 @@ private static int GetWaitTime(DateTime startTimeUtc, int millisecondsTimeout) } /// - /// Flushes all configured Appenders that implement . + /// Flushes all configured Appenders that implement . /// /// The maximum time in milliseconds to wait for logging events from asynchronous appenders to be flushed, /// or to wait indefinitely. diff --git a/src/log4net/ThreadContext.cs b/src/log4net/ThreadContext.cs index f5821910..4267efa1 100644 --- a/src/log4net/ThreadContext.cs +++ b/src/log4net/ThreadContext.cs @@ -34,7 +34,7 @@ namespace log4net; /// /// The thread context has a properties map and a stack. /// The properties and stack can -/// be included in the output of log messages. The +/// be included in the output of log messages. The /// supports selecting and outputting these properties. /// /// diff --git a/src/log4net/Util/EmptyDictionary.cs b/src/log4net/Util/EmptyDictionary.cs index e80f227c..68686572 100644 --- a/src/log4net/Util/EmptyDictionary.cs +++ b/src/log4net/Util/EmptyDictionary.cs @@ -74,7 +74,7 @@ private EmptyDictionary() /// As the collection is empty no values are copied into the array. /// /// - public void CopyTo(System.Array array, int index) + public void CopyTo(Array array, int index) { // copy nothing } diff --git a/src/log4net/Util/GlobalContextProperties.cs b/src/log4net/Util/GlobalContextProperties.cs index 87f9c365..216e867e 100644 --- a/src/log4net/Util/GlobalContextProperties.cs +++ b/src/log4net/Util/GlobalContextProperties.cs @@ -20,7 +20,7 @@ namespace log4net.Util; /// -/// Implementation of Properties collection for the +/// Implementation of Properties collection for the /// /// /// diff --git a/src/log4net/Util/ILogExtensions.cs b/src/log4net/Util/ILogExtensions.cs index 32593e58..1b216abb 100644 --- a/src/log4net/Util/ILogExtensions.cs +++ b/src/log4net/Util/ILogExtensions.cs @@ -63,7 +63,7 @@ public static class LogExtensions /// This check happens always and does not depend on the /// implementation. If this logger is INFO enabled, then it converts /// the message object (retrieved by invocation of the provided callback) to a - /// string by invoking the appropriate . + /// string by invoking the appropriate . /// It then proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -134,7 +134,7 @@ public static void DebugExt(this ILog logger, Func callback, Exception? /// This check happens always and does not depend on the /// implementation. If this logger is INFO enabled, then it converts /// the message object (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -383,7 +383,7 @@ public static void DebugFormatExt(this ILog logger, string format, object? arg0, /// This check happens always and does not depend on the /// implementation. If this logger is INFO enabled, then it converts /// the message object (retrieved by invocation of the provided callback) to a - /// string by invoking the appropriate . + /// string by invoking the appropriate . /// It then proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -454,7 +454,7 @@ public static void InfoExt(this ILog logger, Func callback, Exception? e /// This check happens always and does not depend on the /// implementation. If this logger is INFO enabled, then it converts /// the message object (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -703,7 +703,7 @@ public static void InfoFormatExt(this ILog logger, string format, object? arg0, /// This check happens always and does not depend on the /// implementation. If this logger is WARN enabled, then it converts /// the message object (retrieved by invocation of the provided callback) to a - /// string by invoking the appropriate . + /// string by invoking the appropriate . /// It then proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -774,7 +774,7 @@ public static void WarnExt(this ILog logger, Func callback, Exception? e /// This check happens always and does not depend on the /// implementation. If this logger is WARN enabled, then it converts /// the message object (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -1023,7 +1023,7 @@ public static void WarnFormatExt(this ILog logger, string format, object? arg0, /// This check happens always and does not depend on the /// implementation. If this logger is ERROR enabled, then it converts /// the message object (retrieved by invocation of the provided callback) to a - /// string by invoking the appropriate . + /// string by invoking the appropriate . /// It then proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -1094,7 +1094,7 @@ public static void ErrorExt(this ILog logger, Func callback, Exception? /// This check happens always and does not depend on the /// implementation. If this logger is ERROR enabled, then it converts /// the message object (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -1343,7 +1343,7 @@ public static void ErrorFormatExt(this ILog logger, string format, object? arg0, /// This check happens always and does not depend on the /// implementation. If this logger is FATAL enabled, then it converts /// the message object (retrieved by invocation of the provided callback) to a - /// string by invoking the appropriate . + /// string by invoking the appropriate . /// It then proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. @@ -1414,7 +1414,7 @@ public static void FatalExt(this ILog logger, Func callback, Exception? /// This check happens always and does not depend on the /// implementation. If this logger is FATAL enabled, then it converts /// the message object (passed as parameter) to a string by invoking the appropriate - /// . It then + /// . It then /// proceeds to call all the registered appenders in this logger /// and also higher in the hierarchy depending on the value of /// the additivity flag. diff --git a/src/log4net/Util/LogicalThreadContextProperties.cs b/src/log4net/Util/LogicalThreadContextProperties.cs index 4798fffe..7b4081c3 100644 --- a/src/log4net/Util/LogicalThreadContextProperties.cs +++ b/src/log4net/Util/LogicalThreadContextProperties.cs @@ -28,7 +28,7 @@ namespace log4net.Util; /// -/// Implementation of Properties collection for the +/// Implementation of Properties collection for the /// /// /// @@ -37,7 +37,7 @@ namespace log4net.Util; /// /// /// This class stores its properties in a slot on the named -/// for .net4x, +/// for .net4x, /// otherwise System.Threading.AsyncLocal /// /// diff --git a/src/log4net/Util/OnlyOnceErrorHandler.cs b/src/log4net/Util/OnlyOnceErrorHandler.cs index 395a1805..d0c9ebe2 100644 --- a/src/log4net/Util/OnlyOnceErrorHandler.cs +++ b/src/log4net/Util/OnlyOnceErrorHandler.cs @@ -191,7 +191,7 @@ public DateTime EnabledDate /// The error code from the first error that triggered this error handler. /// /// - /// Defaults to + /// Defaults to /// public ErrorCode ErrorCode { get; private set; } = ErrorCode.GenericFailure; diff --git a/src/log4net/Util/PatternString.cs b/src/log4net/Util/PatternString.cs index 9de37f22..568b272e 100644 --- a/src/log4net/Util/PatternString.cs +++ b/src/log4net/Util/PatternString.cs @@ -35,9 +35,9 @@ namespace log4net.Util; /// when the string is formatted. /// /// -/// This class functions similarly to the +/// This class functions similarly to the /// in that it accepts a pattern and renders it to a string. Unlike the -/// however the +/// however the /// does not render the properties of a specific but /// of the process in general. /// @@ -77,7 +77,7 @@ namespace log4net.Util; /// between braces. For example, %date{HH:mm:ss,fff} or /// %date{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is /// given then ISO8601 format is -/// assumed (). +/// assumed (). /// /// /// The date format specifier admits the same syntax as the @@ -87,9 +87,9 @@ namespace log4net.Util; /// For better results it is recommended to use the log4net date /// formatters. These can be specified using one of the strings /// "ABSOLUTE", "DATE" and "ISO8601" for specifying -/// , -/// and respectively -/// . For example, +/// , +/// and respectively +/// . For example, /// %date{ISO8601} or %date{ABSOLUTE}. /// /// @@ -212,7 +212,7 @@ namespace log4net.Util; /// between braces. For example, %utcdate{HH:mm:ss,fff} or /// %utcdate{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is /// given then ISO8601 format is -/// assumed (). +/// assumed (). /// /// /// The date format specifier admits the same syntax as the @@ -222,9 +222,9 @@ namespace log4net.Util; /// For better results it is recommended to use the log4net date /// formatters. These can be specified using one of the strings /// "ABSOLUTE", "DATE" and "ISO8601" for specifying -/// , -/// and respectively -/// . For example, +/// , +/// and respectively +/// . For example, /// %utcdate{ISO8601} or %utcdate{ABSOLUTE}. /// /// @@ -248,7 +248,7 @@ namespace log4net.Util; /// . /// /// -/// See the for details on the +/// See the for details on the /// format modifiers supported by the patterns. /// /// diff --git a/src/log4net/Util/PatternStringConverters/AppSettingPatternConverter.cs b/src/log4net/Util/PatternStringConverters/AppSettingPatternConverter.cs index cf4e28ab..b3fa9559 100644 --- a/src/log4net/Util/PatternStringConverters/AppSettingPatternConverter.cs +++ b/src/log4net/Util/PatternStringConverters/AppSettingPatternConverter.cs @@ -81,11 +81,11 @@ private static IDictionary AppSettingsDictionary /// /// /// Writes out the value of a named property. The property name - /// should be set in the + /// should be set in the /// property. /// /// - /// If the is set to + /// If the is set to /// then all the properties are written as key value pairs. /// /// diff --git a/src/log4net/Util/PatternStringConverters/DatePatternConverter.cs b/src/log4net/Util/PatternStringConverters/DatePatternConverter.cs index 086f124a..7c56449b 100644 --- a/src/log4net/Util/PatternStringConverters/DatePatternConverter.cs +++ b/src/log4net/Util/PatternStringConverters/DatePatternConverter.cs @@ -34,7 +34,7 @@ namespace log4net.Util.PatternStringConverters; /// the current date and time to the writer as a string. /// /// -/// The value of the determines +/// The value of the determines /// the formatting of the date. The following values are allowed: /// /// diff --git a/src/log4net/Util/PatternStringConverters/EnvironmentFolderPathPatternConverter.cs b/src/log4net/Util/PatternStringConverters/EnvironmentFolderPathPatternConverter.cs index b413e7ad..99e8c7d7 100644 --- a/src/log4net/Util/PatternStringConverters/EnvironmentFolderPathPatternConverter.cs +++ b/src/log4net/Util/PatternStringConverters/EnvironmentFolderPathPatternConverter.cs @@ -24,13 +24,13 @@ namespace log4net.Util.PatternStringConverters; /// -/// Write an folder path to the output +/// Write an folder path to the output /// /// /// -/// The value of the determines -/// the name of the variable to output. -/// should be a value in the enumeration. +/// The value of the determines +/// the name of the variable to output. +/// should be a value in the enumeration. /// /// /// Ron Grabowski @@ -46,7 +46,7 @@ internal sealed class EnvironmentFolderPathPatternConverter : PatternConverter /// /// Writes the special path environment folder path to the output . /// The name of the special path environment folder path to output must be set - /// using the + /// using the /// property. /// /// diff --git a/src/log4net/Util/PatternStringConverters/EnvironmentPatternConverter.cs b/src/log4net/Util/PatternStringConverters/EnvironmentPatternConverter.cs index 70c33456..5ab1f19c 100644 --- a/src/log4net/Util/PatternStringConverters/EnvironmentPatternConverter.cs +++ b/src/log4net/Util/PatternStringConverters/EnvironmentPatternConverter.cs @@ -28,7 +28,7 @@ namespace log4net.Util.PatternStringConverters; /// /// /// Write an environment variable to the output writer. -/// The value of the determines +/// The value of the determines /// the name of the variable to output. /// /// @@ -44,7 +44,7 @@ public sealed class EnvironmentPatternConverter : PatternConverter /// /// Writes the environment variable to the output . /// The name of the environment variable to output must be set - /// using the + /// using the /// property. /// /// diff --git a/src/log4net/Util/PatternStringConverters/LiteralPatternConverter.cs b/src/log4net/Util/PatternStringConverters/LiteralPatternConverter.cs index 96e6aa09..6b053e67 100644 --- a/src/log4net/Util/PatternStringConverters/LiteralPatternConverter.cs +++ b/src/log4net/Util/PatternStringConverters/LiteralPatternConverter.cs @@ -28,7 +28,7 @@ namespace log4net.Util.PatternStringConverters; /// /// /// Writes the literal string value specified in the -/// property to +/// property to /// the output. /// /// @@ -75,7 +75,7 @@ public override PatternConverter SetNext(PatternConverter pc) /// because we have a literal instead. /// /// - /// Writes the value of + /// Writes the value of /// to the output . /// /// diff --git a/src/log4net/Util/PatternStringConverters/PropertyPatternConverter.cs b/src/log4net/Util/PatternStringConverters/PropertyPatternConverter.cs index 3d0c72c9..c5998966 100644 --- a/src/log4net/Util/PatternStringConverters/PropertyPatternConverter.cs +++ b/src/log4net/Util/PatternStringConverters/PropertyPatternConverter.cs @@ -51,11 +51,11 @@ internal sealed class PropertyPatternConverter : PatternConverter /// /// /// Writes out the value of a named property. The property name - /// should be set in the + /// should be set in the /// property. /// /// - /// If the is set to + /// If the is set to /// then all the properties are written as key value pairs. /// /// diff --git a/src/log4net/Util/ReaderWriterLock.cs b/src/log4net/Util/ReaderWriterLock.cs index 7fd52b4f..6a8728ab 100644 --- a/src/log4net/Util/ReaderWriterLock.cs +++ b/src/log4net/Util/ReaderWriterLock.cs @@ -31,7 +31,7 @@ namespace log4net.Util; /// multiple threads, or write access for a single thread. In a /// situation where a resource is changed infrequently, a /// provides better throughput than a simple -/// one-at-a-time lock, such as . +/// one-at-a-time lock, such as . /// /// /// If a platform does not support a System.Threading.ReaderWriterLock diff --git a/src/log4net/Util/SystemStringFormat.cs b/src/log4net/Util/SystemStringFormat.cs index d5f91a9b..0d19571e 100644 --- a/src/log4net/Util/SystemStringFormat.cs +++ b/src/log4net/Util/SystemStringFormat.cs @@ -26,7 +26,7 @@ namespace log4net.Util; /// Utility class that represents a format string. /// /// Nicko Cadell -/// An that supplies culture-specific formatting information. +/// An that supplies culture-specific formatting information. /// A containing zero or more format items. /// An array containing zero or more objects to format. public sealed class SystemStringFormat(IFormatProvider? provider, string format, params object?[]? args) @@ -53,7 +53,7 @@ public sealed class SystemStringFormat(IFormatProvider? provider, string format, /// of the value of a corresponding instance in a specified array. /// A specified parameter supplies culture-specific formatting information. /// - /// An that supplies culture-specific formatting information. + /// An that supplies culture-specific formatting information. /// A containing zero or more format items. /// An array containing zero or more objects to format. /// diff --git a/src/log4net/Util/ThreadContextProperties.cs b/src/log4net/Util/ThreadContextProperties.cs index 6760cf07..5e6f60bb 100644 --- a/src/log4net/Util/ThreadContextProperties.cs +++ b/src/log4net/Util/ThreadContextProperties.cs @@ -22,7 +22,7 @@ namespace log4net.Util; /// -/// Implementation of Properties collection for the +/// Implementation of Properties collection for the /// /// /// diff --git a/src/log4net/Util/ThreadContextStack.cs b/src/log4net/Util/ThreadContextStack.cs index 774cfc96..6b7a9375 100644 --- a/src/log4net/Util/ThreadContextStack.cs +++ b/src/log4net/Util/ThreadContextStack.cs @@ -26,11 +26,11 @@ namespace log4net.Util; /// -/// Implementation of Stack for the +/// Implementation of Stack for the /// /// /// -/// Implementation of Stack for the +/// Implementation of Stack for the /// /// /// Nicko Cadell @@ -258,7 +258,7 @@ internal string? FullMessage } /// - /// Struct returned from the method. + /// Struct returned from the method. /// /// /// diff --git a/src/log4net/Util/ThreadContextStacks.cs b/src/log4net/Util/ThreadContextStacks.cs index cade059f..b2c09766 100644 --- a/src/log4net/Util/ThreadContextStacks.cs +++ b/src/log4net/Util/ThreadContextStacks.cs @@ -22,7 +22,7 @@ namespace log4net.Util; /// -/// Implementation of Stacks collection for the +/// Implementation of Stacks collection for the /// /// Nicko Cadell public sealed class ThreadContextStacks diff --git a/src/log4net/Util/TypeConverters/PatternStringConverter.cs b/src/log4net/Util/TypeConverters/PatternStringConverter.cs index 7af6687c..edd3a6ac 100644 --- a/src/log4net/Util/TypeConverters/PatternStringConverter.cs +++ b/src/log4net/Util/TypeConverters/PatternStringConverter.cs @@ -89,7 +89,7 @@ public object ConvertTo(object source, Type targetType) /// if the is /// the type. /// - public bool CanConvertFrom(System.Type sourceType) => sourceType == typeof(string); + public bool CanConvertFrom(Type sourceType) => sourceType == typeof(string); /// /// Overrides the ConvertFrom method of IConvertFrom. diff --git a/src/log4net/Util/WindowsSecurityContext.cs b/src/log4net/Util/WindowsSecurityContext.cs index 9a00c318..3eee0b87 100644 --- a/src/log4net/Util/WindowsSecurityContext.cs +++ b/src/log4net/Util/WindowsSecurityContext.cs @@ -47,7 +47,7 @@ public class WindowsSecurityContext : Core.SecurityContext, IOptionHandler /// /// /// - /// See the property for + /// See the property for /// details. /// /// @@ -219,7 +219,7 @@ public void ActivateOptions() /// token is used to initialize the WindowsIdentity. /// /// - [System.Security.SecuritySafeCritical] + [SecuritySafeCritical] [System.Security.Permissions.SecurityPermission(System.Security.Permissions.SecurityAction.Demand, UnmanagedCode = true)] private static WindowsIdentity LogonUser(string userName, string domainName, string password) {