Skip to content

Commit

Permalink
SA1642
Browse files Browse the repository at this point in the history
  • Loading branch information
bdukes committed Jun 12, 2020
1 parent 8c96fb9 commit c91349e
Show file tree
Hide file tree
Showing 216 changed files with 1,111 additions and 779 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,18 @@ public static AppenderCollection ReadOnly(AppenderCollection list)
/// </summary>
public static readonly AppenderCollection EmptyCollection = ReadOnly(new AppenderCollection(0));

/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="AppenderCollection"/> class.
/// Initializes a new instance of the <c>AppenderCollection</c> class
/// that is empty and has the default initial capacity.
/// </summary>
public AppenderCollection()
{
this.m_array = new IAppender[DEFAULT_CAPACITY];
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="AppenderCollection"/> class.
/// Initializes a new instance of the <c>AppenderCollection</c> class
/// that has the specified initial capacity.
/// </summary>
Expand All @@ -109,9 +111,10 @@ public AppenderCollection()
public AppenderCollection(int capacity)
{
this.m_array = new IAppender[capacity];
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="AppenderCollection"/> class.
/// Initializes a new instance of the <c>AppenderCollection</c> class
/// that contains elements copied from the specified <c>AppenderCollection</c>.
/// </summary>
Expand All @@ -120,9 +123,10 @@ public AppenderCollection(AppenderCollection c)
{
this.m_array = new IAppender[c.Count];
this.AddRange(c);
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="AppenderCollection"/> class.
/// Initializes a new instance of the <c>AppenderCollection</c> class
/// that contains elements copied from the specified <see cref="IAppender"/> array.
/// </summary>
Expand All @@ -131,9 +135,10 @@ public AppenderCollection(IAppender[] a)
{
this.m_array = new IAppender[a.Length];
this.AddRange(a);
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="AppenderCollection"/> class.
/// Initializes a new instance of the <c>AppenderCollection</c> class
/// that contains elements copied from the specified <see cref="IAppender"/> collection.
/// </summary>
Expand All @@ -155,9 +160,10 @@ internal protected enum Tag
/// A value
/// </summary>
Default,
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="AppenderCollection"/> class.
/// Allow subclasses to avoid our default constructors.
/// </summary>
/// <param name="tag"></param>
Expand Down Expand Up @@ -636,7 +642,8 @@ private sealed class Enumerator : IEnumerator, IAppenderCollectionEnumerator
private int m_index;
private int m_version;

/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="Enumerator"/> class.
/// Initializes a new instance of the <c>Enumerator</c> class.
/// </summary>
/// <param name="tc"></param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ namespace log4net.Appender
/// <author>Gert Driesen.</author>
public abstract class AppenderSkeleton : IAppender, IBulkAppender, IOptionHandler, IFlushable
{
/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="AppenderSkeleton"/> class.
/// Default constructor.
/// </summary>
/// <remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ namespace log4net.Appender
/// <author>Nicko Cadell.</author>
public class DebugAppender : AppenderSkeleton
{
/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="DebugAppender"/> class.
/// Initializes a new instance of the <see cref="DebugAppender" />.
/// </summary>
/// <remarks>
Expand All @@ -53,9 +54,10 @@ public class DebugAppender : AppenderSkeleton
/// </remarks>
public DebugAppender()
{
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="DebugAppender"/> class.
/// Initializes a new instance of the <see cref="DebugAppender" />
/// with a specified layout.
/// </summary>
Expand Down
17 changes: 10 additions & 7 deletions DNN Platform/DotNetNuke.Log4net/log4net/Appender/FileAppender.cs
Original file line number Diff line number Diff line change
Expand Up @@ -886,7 +886,8 @@ public override void OnClose()
}
#endif

/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="FileAppender"/> class.
/// Default constructor.
/// </summary>
/// <remarks>
Expand All @@ -896,9 +897,10 @@ public override void OnClose()
/// </remarks>
public FileAppender()
{
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="FileAppender"/> class.
/// Construct a new appender using the layout, file and append mode.
/// </summary>
/// <param name="layout">the layout to use with this appender.</param>
Expand All @@ -916,9 +918,10 @@ public FileAppender(ILayout layout, string filename, bool append)
this.File = filename;
this.AppendToFile = append;
this.ActivateOptions();
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="FileAppender"/> class.
/// Construct a new appender using the layout and file specified.
/// The file will be appended to.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,8 @@ public class NetSendAppender : AppenderSkeleton
/// </summary>
private SecurityContext m_securityContext;

/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="NetSendAppender"/> class.
/// Initializes the appender.
/// </summary>
/// <remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ namespace log4net.Appender
/// <author>Gert Driesen.</author>
public class SmtpAppender : BufferingAppenderSkeleton
{
/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="SmtpAppender"/> class.
/// Default constructor.
/// </summary>
/// <remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ namespace log4net.Appender
/// <author>Nicko Cadell.</author>
public class SmtpPickupDirAppender : BufferingAppenderSkeleton
{
/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="SmtpPickupDirAppender"/> class.
/// Default constructor.
/// </summary>
/// <remarks>
Expand Down
17 changes: 10 additions & 7 deletions DNN Platform/DotNetNuke.Log4net/log4net/Appender/TelnetAppender.cs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ public class TelnetAppender : AppenderSkeleton
private SocketHandler m_handler;
private int m_listeningPort = 23;

/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="TelnetAppender"/> class.
/// Default constructor.
/// </summary>
/// <remarks>
Expand Down Expand Up @@ -231,9 +232,10 @@ protected class SocketHandler : IDisposable
protected class SocketClient : IDisposable
{
private Socket m_socket;
private StreamWriter m_writer;

/// <summary>
private StreamWriter m_writer;

/// <summary>
/// Initializes a new instance of the <see cref="SocketClient"/> class.
/// Create this <see cref="SocketClient"/> for the specified <see cref="Socket"/>.
/// </summary>
/// <param name="socket">the client's socket.</param>
Expand Down Expand Up @@ -315,9 +317,10 @@ public void Dispose()
this.m_socket = null;
}
}
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="SocketHandler"/> class.
/// Opens a new server port on <paramref ref="port"/>.
/// </summary>
/// <param name="port">the local port to listen on for connections.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ namespace log4net.Appender
/// <author>Ron Grabowski.</author>
public class TraceAppender : AppenderSkeleton
{
/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="TraceAppender"/> class.
/// Initializes a new instance of the <see cref="TraceAppender" />.
/// </summary>
/// <remarks>
Expand All @@ -64,9 +65,10 @@ public class TraceAppender : AppenderSkeleton
/// </remarks>
public TraceAppender()
{
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="TraceAppender"/> class.
/// Initializes a new instance of the <see cref="TraceAppender" />
/// with a specified layout.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,10 @@ namespace log4net.Config
[AttributeUsage(AttributeTargets.Assembly)]
public abstract class ConfiguratorAttribute : Attribute, IComparable
{
private int m_priority = 0;

/// <summary>
private int m_priority = 0;

/// <summary>
/// Initializes a new instance of the <see cref="ConfiguratorAttribute"/> class.
/// Constructor used by subclasses.
/// </summary>
/// <param name="priority">the ordering priority for this configurator.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ namespace log4net.Config
[Obsolete("Use XmlConfigurator instead of DOMConfigurator. Scheduled removal in v10.0.0.")]
public sealed class DOMConfigurator
{
/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="DOMConfigurator"/> class.
/// Private constructor.
/// </summary>
private DOMConfigurator()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,10 @@ public sealed class DomainAttribute : RepositoryAttribute
public DomainAttribute()
: base()
{
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="DomainAttribute"/> class.
/// Initialize a new instance of the <see cref="DomainAttribute" /> class
/// with the name of the domain.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,10 @@ namespace log4net.Config
/// </remarks>
public RepositoryAttribute()
{
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="RepositoryAttribute"/> class.
/// Initialize a new instance of the <see cref="RepositoryAttribute" /> class
/// with the name of the repository.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ namespace log4net.Config
[Serializable]
public sealed class SecurityContextProviderAttribute : ConfiguratorAttribute
{
/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="SecurityContextProviderAttribute"/> class.
/// Construct provider attribute with type specified.
/// </summary>
/// <param name="providerType">the type of the provider to use.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ namespace log4net.Config
/// <author>Gert Driesen.</author>
public sealed class XmlConfigurator
{
/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="XmlConfigurator"/> class.
/// Private constructor.
/// </summary>
private XmlConfigurator()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,12 @@ namespace log4net.Config
[AttributeUsage(AttributeTargets.Assembly)]
[Serializable]
public /*sealed*/ class XmlConfiguratorAttribute : ConfiguratorAttribute
{
// Class is not sealed because DOMConfiguratorAttribute extends it while it is obsoleted
//

/// <summary>
{
// Class is not sealed because DOMConfiguratorAttribute extends it while it is obsoleted
//

/// <summary>
/// Initializes a new instance of the <see cref="XmlConfiguratorAttribute"/> class.
/// Default constructor.
/// </summary>
/// <remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ public class CompactRepositorySelector : IRepositorySelector

private event LoggerRepositoryCreationEventHandler m_loggerRepositoryCreatedEvent;

/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="CompactRepositorySelector"/> class.
/// Create a new repository selector.
/// </summary>
/// <param name="defaultRepositoryType">the type of the repositories to create, must implement <see cref="ILoggerRepository"/>.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ public event LoggerRepositoryCreationEventHandler LoggerRepositoryCreatedEvent
remove { this.m_loggerRepositoryCreatedEvent -= value; }
}

/// <summary>
/// <summary>
/// Initializes a new instance of the <see cref="DefaultRepositorySelector"/> class.
/// Creates a new repository selector.
/// </summary>
/// <param name="defaultRepositoryType">The type of the repositories to create, must implement <see cref="ILoggerRepository"/>.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,19 @@ public class ExceptionEvaluator : ITriggeringEventEvaluator
/// <summary>
/// Causes subclasses of <see cref="ExceptionType"/> to cause the trigger to fire.
/// </summary>
private bool m_triggerOnSubclass;

/// <summary>
private bool m_triggerOnSubclass;

/// <summary>
/// Initializes a new instance of the <see cref="ExceptionEvaluator"/> class.
/// Default ctor to allow dynamic creation through a configurator.
/// </summary>
public ExceptionEvaluator()
{
// empty
}

/// <summary>
}

/// <summary>
/// Initializes a new instance of the <see cref="ExceptionEvaluator"/> class.
/// Constructs an evaluator and initializes to trigger on <paramref name="exType"/>.
/// </summary>
/// <param name="exType">the type that triggers this evaluator.</param>
Expand Down
Loading

0 comments on commit c91349e

Please sign in to comment.