diff --git a/GBase.Logging/Factories/IConsoleLoggerFactory.cs b/GBase.Logging/Factories/IConsoleLoggerFactory.cs index 18a2f30..266e8d8 100644 --- a/GBase.Logging/Factories/IConsoleLoggerFactory.cs +++ b/GBase.Logging/Factories/IConsoleLoggerFactory.cs @@ -7,8 +7,15 @@ using GBase.Logging.Interfaces; namespace GBase.Logging.Factories { + /// + /// Factory for the + /// public interface IConsoleLoggerFactory { + /// + /// Creates an + /// + /// A newly created instance of the implementation for IConsoleLogger Create(); } } \ No newline at end of file diff --git a/GBase.Logging/Factories/IFileLoggerFactory.cs b/GBase.Logging/Factories/IFileLoggerFactory.cs index c1b1b40..630be5c 100644 --- a/GBase.Logging/Factories/IFileLoggerFactory.cs +++ b/GBase.Logging/Factories/IFileLoggerFactory.cs @@ -7,8 +7,17 @@ using GBase.Logging.Interfaces; namespace GBase.Logging.Factories { + /// + /// Factory for the + /// public interface IFileLoggerFactory { + /// + /// Creates an + /// + /// The directory of the LogFile + /// The path of the LogFile + /// A newly created instance of the implementation for IFileLogger Create(string filePath, string fileName); } } \ No newline at end of file diff --git a/GBase.Logging/Factories/ILogFactory.cs b/GBase.Logging/Factories/ILogFactory.cs index dc9d0b4..f8d62f6 100644 --- a/GBase.Logging/Factories/ILogFactory.cs +++ b/GBase.Logging/Factories/ILogFactory.cs @@ -7,8 +7,15 @@ using GBase.Logging.Interfaces; namespace GBase.Logging.Factories { + /// + /// Factory for the + /// public interface ILogFactory { + /// + /// Creates an + /// + /// A newly created instance of the implementation for ILog Create(); } } \ No newline at end of file diff --git a/GBase.Logging/GBase.Logging.csproj b/GBase.Logging/GBase.Logging.csproj index 0e7e514..2144249 100644 --- a/GBase.Logging/GBase.Logging.csproj +++ b/GBase.Logging/GBase.Logging.csproj @@ -2,6 +2,13 @@ netstandard2.1 + SimonG + SimonG + Copyright(c) 2020 SimonG. All Rights Reserved. + + + + D:\workspace\Testprojekte\GBase\GBase.Logging\GBase.Logging.xml diff --git a/GBase.Logging/GBase.Logging.xml b/GBase.Logging/GBase.Logging.xml new file mode 100644 index 0000000..8d3b0cb --- /dev/null +++ b/GBase.Logging/GBase.Logging.xml @@ -0,0 +1,364 @@ + + + + GBase.Logging + + + + + An that writes log messages to the + + + + + Write the given to the + + The + + + + the + + + + + Factory for the + + + + + Creates an + + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + The directory of the LogFile + The path of the LogFile + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + A newly created instance of the implementation for + + + + An that writes log messages to a set file + + + + + Constructor for + + The directory of the LogFile + The path of the LogFile + + + + Write the given to the file + + The + + + + the + + + + + for the logging + + + + + + + + An that writes log messages to the + + + + + An that writes log messages to a set file + + + + + The main logging interface + + + + + Initialize the + + True if successful, false if not + + + + Set the of the current instance + + The + + + + Add an to the + + The + + + + Remove an from the + + The + + + + The + + + + + The + + + + + Base class for loggers + + + + + Write the given + + The + + + + An interface that is used to handle log messages + + + + + The of the + + + + + The of the + + + + + The of the + + + + + The of the + + + + + The main logging class + + + + + Constructor for + + + + + of s that are subscribed to this + + + + + The of this logging instance + + + + + Initialize the + + True if successful, false if not + + + + Set the of the current instance + + The + + + + Add an to the + + The + + + + Remove an from the + + The + + + + Write a given to the set s + + The + The of the caller + + + + Write a given to the set s + + The + The + + + + Write a given to the set s + + The + The of the caller + + + + Write a given with the to the set s + + + The of the caller + + + + Write a given with the of the calling and the to the set s + + The + The given + The of the caller + + + + Write a given with the and the to the set s + + The + The + The given + + + + Get the default for the given + + The + + + + + the + + + + + Event that is fired when is called + is the newly set + + + + + The attribute + + + + + constructor + + The + + + + The + + + + + Returns the of this + + The + + + + The available + + + + + No logging + + + + + Error logging + + + + + Default logging + + + + + Advanced logging + + + + + Debug logging + + + + + Implementation of + + + + + The of the + + + + + The of the + + + + + The of the + + + + + The of the + + + + + Builds the out of all parts and returns it as a + + The as a + + + diff --git a/GBase.Logging/Installers/LoggingInstaller.cs b/GBase.Logging/Installers/LoggingInstaller.cs index 66b146b..06cdf80 100644 --- a/GBase.Logging/Installers/LoggingInstaller.cs +++ b/GBase.Logging/Installers/LoggingInstaller.cs @@ -10,8 +10,12 @@ using LightweightIocContainer.Interfaces.Installers; namespace GBase.Logging.Installers { + /// + /// for the logging + /// public class LoggingInstaller : IIocInstaller { + /// public void Install(IIocContainer container) { container.Register(); diff --git a/GBase.Logging/Interfaces/IConsoleLogger.cs b/GBase.Logging/Interfaces/IConsoleLogger.cs index 201ff6b..ccb6f1b 100644 --- a/GBase.Logging/Interfaces/IConsoleLogger.cs +++ b/GBase.Logging/Interfaces/IConsoleLogger.cs @@ -2,8 +2,13 @@ // Created: 2020-02-12 // Copyright(c) 2020 SimonG. All Rights Reserved. +using System; + namespace GBase.Logging.Interfaces { + /// + /// An that writes log messages to the + /// public interface IConsoleLogger : ILogger { diff --git a/GBase.Logging/Interfaces/IFileLogger.cs b/GBase.Logging/Interfaces/IFileLogger.cs index a0cd623..5e4ed69 100644 --- a/GBase.Logging/Interfaces/IFileLogger.cs +++ b/GBase.Logging/Interfaces/IFileLogger.cs @@ -4,6 +4,9 @@ namespace GBase.Logging.Interfaces { + /// + /// An that writes log messages to a set file + /// public interface IFileLogger : ILogger {