Ellpeck/ExtremelySimpleLogger
1
0
Fork 0
mirror of https://github.com/Ellpeck/ExtremelySimpleLogger.git synced 2024-11-22 10:03:29 +01:00
Code Issues Projects Releases Wiki Activity

fixed some documentation inconsistencies

Browse source
This commit is contained in:
Ellpeck 2020-07-23 14:03:25 +02:00
parent 80123b7748
commit ef63ac958c
3 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
ExtremelySimpleLogger/FileSink.cs
View file

@ -56,10 +56,12 @@ namespace ExtremelySimpleLogger {
} }
} }
/// <summary>
/// Disposes this sink, freeing all of the resources it uses. /// Disposes this sink, freeing all of the resources it uses.
/// </summary>
public override void Dispose() { public override void Dispose() {
base.Dispose(); base.Dispose();
if(!this.reopenOnWrite) if (!this.reopenOnWrite)
this.writer.Dispose(); this.writer.Dispose();
} }

2
ExtremelySimpleLogger/Logger.cs
View file

@ -4,9 +4,7 @@ using System.Collections.Generic;
namespace ExtremelySimpleLogger { namespace ExtremelySimpleLogger {
/// <summary> /// <summary>
/// The implementation of a logger, which is a wrapper class around multiple logging <see cref="Sinks"/>. /// The implementation of a logger, which is a wrapper class around multiple logging <see cref="Sinks"/>.
///
/// To start logging with a logger, its <see cref="Sinks"/> need to be initialized. /// To start logging with a logger, its <see cref="Sinks"/> need to be initialized.
/// There are two default implementations: <see cref="FileSink"/>, <see cref="ConsoleSink"/> and <see cref="StringSink"/>.
/// </summary> /// </summary>
public class Logger : IDisposable { public class Logger : IDisposable {

1
ExtremelySimpleLogger/Sink.cs
View file

@ -4,7 +4,6 @@ using System.Text;
namespace ExtremelySimpleLogger { namespace ExtremelySimpleLogger {
/// <summary> /// <summary>
/// A sink is a way for log messages passed to a <see cref="Logger"/> to be processed in a certain way. /// A sink is a way for log messages passed to a <see cref="Logger"/> to be processed in a certain way.
/// By default, <see cref="FileSink"/> and <see cref="ConsoleSink"/> are available.
/// </summary> /// </summary>
public abstract class Sink : IDisposable { public abstract class Sink : IDisposable {