mirror of
https://github.com/Ellpeck/ExtremelySimpleLogger.git
synced 2024-12-22 05:09:24 +01:00
fixed some documentation inconsistencies
This commit is contained in:
parent
80123b7748
commit
ef63ac958c
3 changed files with 3 additions and 4 deletions
|
@ -56,10 +56,12 @@ namespace ExtremelySimpleLogger {
|
|||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Disposes this sink, freeing all of the resources it uses.
|
||||
/// </summary>
|
||||
public override void Dispose() {
|
||||
base.Dispose();
|
||||
if(!this.reopenOnWrite)
|
||||
if (!this.reopenOnWrite)
|
||||
this.writer.Dispose();
|
||||
}
|
||||
|
||||
|
|
|
@ -4,9 +4,7 @@ using System.Collections.Generic;
|
|||
namespace ExtremelySimpleLogger {
|
||||
/// <summary>
|
||||
/// 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.
|
||||
/// There are two default implementations: <see cref="FileSink"/>, <see cref="ConsoleSink"/> and <see cref="StringSink"/>.
|
||||
/// </summary>
|
||||
public class Logger : IDisposable {
|
||||
|
||||
|
|
|
@ -4,7 +4,6 @@ using System.Text;
|
|||
namespace ExtremelySimpleLogger {
|
||||
/// <summary>
|
||||
/// 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>
|
||||
public abstract class Sink : IDisposable {
|
||||
|
||||
|
|
Loading…
Reference in a new issue