- add documentation .xml

- add missing class and file comments

GBase.Logging/Factories/IConsoleLoggerFactory.cs

@@ -7,8 +7,15 @@ using GBase.Logging.Interfaces;
 
 namespace GBase.Logging.Factories
 {
+    /// <summary>
+    /// Factory for the <see cref="IConsoleLogger"/>
+    /// </summary>
     public interface IConsoleLoggerFactory
     {
+        /// <summary>
+        /// Creates an <see cref="IConsoleLogger"/>
+        /// </summary>
+        /// <returns>A newly created instance of the implementation for <see cref="IConsoleLogger"/></returns>
         IConsoleLogger Create();
     }
 }

GBase.Logging/Factories/IFileLoggerFactory.cs

@@ -7,8 +7,17 @@ using GBase.Logging.Interfaces;
 
 namespace GBase.Logging.Factories
 {
+    /// <summary>
+    /// Factory for the <see cref="IFileLogger"/>
+    /// </summary>
     public interface IFileLoggerFactory
     {
+        /// <summary>
+        /// Creates an <see cref="IFileLogger"/>
+        /// </summary>
+        /// <param name="filePath">The directory of the LogFile</param>
+        /// <param name="fileName">The path of the LogFile</param>
+        /// <returns>A newly created instance of the implementation for <see cref="IFileLogger"/></returns>
         IFileLogger Create(string filePath, string fileName);
     }
 }

GBase.Logging/Factories/ILogFactory.cs

@@ -7,8 +7,15 @@ using GBase.Logging.Interfaces;
 
 namespace GBase.Logging.Factories
 {
+    /// <summary>
+    /// Factory for the <see cref="ILog"/>
+    /// </summary>
     public interface ILogFactory
     {
+        /// <summary>
+        /// Creates an <see cref="ILog"/>
+        /// </summary>
+        /// <returns>A newly created instance of the implementation for <see cref="ILog"/></returns>
         ILog Create();
     }
 }

GBase.Logging/GBase.Logging.csproj

@@ -2,6 +2,13 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
+    <Authors>SimonG</Authors>
+    <Company>SimonG</Company>
+    <Copyright>Copyright(c) 2020 SimonG. All Rights Reserved.</Copyright>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>D:\workspace\Testprojekte\GBase\GBase.Logging\GBase.Logging.xml</DocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

GBase.Logging/GBase.Logging.xml

@@ -0,0 +1,364 @@
+<?xml version="1.0"?>
+<doc>
+    <assembly>
+        <name>GBase.Logging</name>
+    </assembly>
+    <members>
+        <member name="T:GBase.Logging.ConsoleLogger">
+            <summary>
+            An <see cref="T:GBase.Logging.Interfaces.ILogger"/> that writes log messages to the <see cref="T:System.Console"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.ConsoleLogger.Write(GBase.Logging.Interfaces.ILogMessage)">
+            <summary>
+            Write the given <see cref="T:System.String"/> to the <see cref="T:System.Console"/>
+            </summary>
+            <param name="message">The <see cref="T:GBase.Logging.Interfaces.ILogMessage"/></param>
+        </member>
+        <member name="M:GBase.Logging.ConsoleLogger.DisposeAsync">
+            <summary>
+            <see cref="M:GBase.Logging.ConsoleLogger.DisposeAsync"/> the <see cref="T:GBase.Logging.ConsoleLogger"/>
+            </summary>
+        </member>
+        <member name="T:GBase.Logging.Factories.IConsoleLoggerFactory">
+            <summary>
+            Factory for the <see cref="T:GBase.Logging.Interfaces.IConsoleLogger"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.Factories.IConsoleLoggerFactory.Create">
+            <summary>
+            Creates an <see cref="T:GBase.Logging.Interfaces.IConsoleLogger"/>
+            </summary>
+            <returns>A newly created instance of the implementation for <see cref="T:GBase.Logging.Interfaces.IConsoleLogger"/></returns>
+        </member>
+        <member name="T:GBase.Logging.Factories.IFileLoggerFactory">
+            <summary>
+            Factory for the <see cref="T:GBase.Logging.Interfaces.IFileLogger"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.Factories.IFileLoggerFactory.Create(System.String,System.String)">
+            <summary>
+            Creates an <see cref="T:GBase.Logging.Interfaces.IFileLogger"/>
+            </summary>
+            <param name="filePath">The directory of the LogFile</param>
+            <param name="fileName">The path of the LogFile</param>
+            <returns>A newly created instance of the implementation for <see cref="T:GBase.Logging.Interfaces.IFileLogger"/></returns>
+        </member>
+        <member name="T:GBase.Logging.Factories.ILogFactory">
+            <summary>
+            Factory for the <see cref="T:GBase.Logging.Interfaces.ILog"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.Factories.ILogFactory.Create">
+            <summary>
+            Creates an <see cref="T:GBase.Logging.Interfaces.ILog"/>
+            </summary>
+            <returns>A newly created instance of the implementation for <see cref="T:GBase.Logging.Interfaces.ILog"/></returns>
+        </member>
+        <member name="T:GBase.Logging.FileLogger">
+            <summary>
+            An <see cref="T:GBase.Logging.Interfaces.ILogger"/> that writes log messages to a set file
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.FileLogger.#ctor(System.String,System.String)">
+            <summary>
+            Constructor for <see cref="T:GBase.Logging.FileLogger"/>
+            </summary>
+            <param name="filePath">The directory of the LogFile</param>
+            <param name="fileName">The path of the LogFile</param>
+        </member>
+        <member name="M:GBase.Logging.FileLogger.Write(GBase.Logging.Interfaces.ILogMessage)">
+            <summary>
+            Write the given <see cref="T:System.String"/> to the file
+            </summary>
+            <param name="message">The <see cref="T:GBase.Logging.Interfaces.ILogMessage"/></param>
+        </member>
+        <member name="M:GBase.Logging.FileLogger.DisposeAsync">
+            <summary>
+            <see cref="M:GBase.Logging.FileLogger.DisposeAsync"/> the <see cref="T:GBase.Logging.FileLogger"/>
+            </summary>
+        </member>
+        <member name="T:GBase.Logging.Installers.LoggingInstaller">
+            <summary>
+            <see cref="T:LightweightIocContainer.Interfaces.Installers.IIocInstaller"/> for the logging
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.Installers.LoggingInstaller.Install(LightweightIocContainer.Interfaces.IIocContainer)">
+            <inheritdoc />
+        </member>
+        <member name="T:GBase.Logging.Interfaces.IConsoleLogger">
+            <summary>
+            An <see cref="T:GBase.Logging.Interfaces.ILogger"/> that writes log messages to the <see cref="T:System.Console"/>
+            </summary>
+        </member>
+        <member name="T:GBase.Logging.Interfaces.IFileLogger">
+            <summary>
+            An <see cref="T:GBase.Logging.Interfaces.ILogger"/> that writes log messages to a set file
+            </summary>
+        </member>
+        <member name="T:GBase.Logging.Interfaces.ILog">
+            <summary>
+            The main logging interface
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.Interfaces.ILog.InitializeLog">
+            <summary>
+            Initialize the <see cref="T:GBase.Logging.Interfaces.ILog"/>
+            </summary>
+            <returns>True if successful, false if not</returns>
+        </member>
+        <member name="M:GBase.Logging.Interfaces.ILog.SetLogLevel(GBase.Logging.LogLevels)">
+            <summary>
+            Set the <see cref="T:GBase.Logging.LogLevels"/> of the current <see cref="T:GBase.Logging.Interfaces.ILog"/> instance
+            </summary>
+            <param name="logLevel">The <see cref="T:GBase.Logging.LogLevels"/></param>
+        </member>
+        <member name="M:GBase.Logging.Interfaces.ILog.AddLogger(GBase.Logging.Interfaces.ILogger)">
+            <summary>
+            Add an <see cref="T:GBase.Logging.Interfaces.ILogger"/> to the <see cref="T:GBase.Logging.Interfaces.ILog"/>
+            </summary>
+            <param name="logger">The <see cref="T:GBase.Logging.Interfaces.ILogger"/></param>
+        </member>
+        <member name="M:GBase.Logging.Interfaces.ILog.RemoveLogger(GBase.Logging.Interfaces.ILogger)">
+            <summary>
+            Remove an <see cref="T:GBase.Logging.Interfaces.ILogger"/> from the <see cref="T:GBase.Logging.Interfaces.ILog"/>
+            </summary>
+            <param name="logger">The <see cref="T:GBase.Logging.Interfaces.ILogger"/></param>
+        </member>
+        <member name="T:GBase.Logging.Interfaces.ILogComponent">
+            <summary>
+            The <see cref="T:GBase.Logging.Interfaces.ILogComponent"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.Interfaces.ILogComponent.Component">
+            <summary>
+            The <see cref="P:GBase.Logging.Interfaces.ILogComponent.Component"/>
+            </summary>
+        </member>
+        <member name="T:GBase.Logging.Interfaces.ILogger">
+            <summary>
+            Base class for loggers
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.Interfaces.ILogger.Write(GBase.Logging.Interfaces.ILogMessage)">
+            <summary>
+            Write the given <see cref="T:GBase.Logging.Interfaces.ILogMessage"/>
+            </summary>
+            <param name="message">The <see cref="T:GBase.Logging.Interfaces.ILogMessage"/></param>
+        </member>
+        <member name="T:GBase.Logging.Interfaces.ILogMessage">
+            <summary>
+            An interface that is used to handle log messages
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.Interfaces.ILogMessage.LogLevel">
+            <summary>
+            The <see cref="T:GBase.Logging.LogLevels"/> of the <see cref="T:GBase.Logging.Interfaces.ILogMessage"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.Interfaces.ILogMessage.Timestamp">
+            <summary>
+            The <see cref="P:GBase.Logging.Interfaces.ILogMessage.Timestamp"/> of the <see cref="T:GBase.Logging.Interfaces.ILogMessage"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.Interfaces.ILogMessage.Component">
+            <summary>
+            The <see cref="T:GBase.Logging.Interfaces.ILogComponent"/> of the <see cref="T:GBase.Logging.Interfaces.ILogMessage"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.Interfaces.ILogMessage.Message">
+            <summary>
+            The <see cref="P:GBase.Logging.Interfaces.ILogMessage.Message"/> of the <see cref="T:GBase.Logging.Interfaces.ILogMessage"/>
+            </summary>
+        </member>
+        <member name="T:GBase.Logging.Log">
+            <summary>
+            The main logging class
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.Log.#ctor">
+            <summary>
+            Constructor for <see cref="T:GBase.Logging.Log"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.Log.Loggers">
+            <summary>
+            <see cref="T:System.Collections.Generic.List`1"/> of <see cref="T:GBase.Logging.Interfaces.ILogger"/>s that are subscribed to this <see cref="T:GBase.Logging.Log"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.Log.LogLevel">
+            <summary>
+            The <see cref="T:GBase.Logging.LogLevels"/> of this logging instance
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.Log.InitializeLog">
+            <summary>
+            Initialize the <see cref="T:GBase.Logging.Interfaces.ILog"/>
+            </summary>
+            <returns>True if successful, false if not</returns>
+        </member>
+        <member name="M:GBase.Logging.Log.SetLogLevel(GBase.Logging.LogLevels)">
+            <summary>
+            Set the <see cref="T:GBase.Logging.LogLevels"/> of the current <see cref="T:GBase.Logging.Log"/> instance
+            </summary>
+            <param name="logLevel">The <see cref="T:GBase.Logging.LogLevels"/></param>
+        </member>
+        <member name="M:GBase.Logging.Log.AddLogger(GBase.Logging.Interfaces.ILogger)">
+            <summary>
+            Add an <see cref="T:GBase.Logging.Interfaces.ILogger"/> to the <see cref="T:GBase.Logging.Log"/>
+            </summary>
+            <param name="logger">The <see cref="T:GBase.Logging.Interfaces.ILogger"/></param>
+        </member>
+        <member name="M:GBase.Logging.Log.RemoveLogger(GBase.Logging.Interfaces.ILogger)">
+            <summary>
+            Remove an <see cref="T:GBase.Logging.Interfaces.ILogger"/> from the <see cref="T:GBase.Logging.Log"/>
+            </summary>
+            <param name="logger">The <see cref="T:GBase.Logging.Interfaces.ILogger"/></param>
+        </member>
+        <member name="M:GBase.Logging.Log.Write``1(System.Exception)">
+            <summary>
+            Write a given <see cref="T:System.Exception"/> to the set <see cref="T:GBase.Logging.Interfaces.ILogger"/>s
+            </summary>
+            <param name="ex">The <see cref="T:System.Exception"/></param>
+            <typeparam name="T">The <see cref="T:System.Type"/> of the caller</typeparam>
+        </member>
+        <member name="M:GBase.Logging.Log.Write(GBase.Logging.Interfaces.ILogComponent,System.Exception)">
+            <summary>
+            Write a given <see cref="T:System.Exception"/> to the set <see cref="T:GBase.Logging.Interfaces.ILogger"/>s
+            </summary>
+            <param name="component">The <see cref="T:GBase.Logging.Interfaces.ILogComponent"/></param>
+            <param name="ex">The <see cref="T:System.Exception"/></param>
+        </member>
+        <member name="M:GBase.Logging.Log.Write``1(System.AggregateException)">
+            <summary>
+            Write a given <see cref="T:System.AggregateException"/> to the set <see cref="T:GBase.Logging.Interfaces.ILogger"/>s
+            </summary>
+            <param name="ex">The <see cref="T:System.AggregateException"/></param>
+            <typeparam name="T">The <see cref="T:System.Type"/> of the caller</typeparam>
+        </member>
+        <member name="M:GBase.Logging.Log.Write``1(System.String)">
+            <summary>
+            Write a given <see cref="T:System.String"/> with the <see cref="F:GBase.Logging.LogLevels.Default"/> to the set <see cref="T:GBase.Logging.Interfaces.ILogger"/>s
+            </summary>
+            <param name="line"></param>
+            <typeparam name="T">The <see cref="T:System.Type"/> of the caller</typeparam>
+        </member>
+        <member name="M:GBase.Logging.Log.Write``1(GBase.Logging.LogLevels,System.String)">
+            <summary>
+            Write a given <see cref="T:System.String"/> with the <see cref="T:GBase.Logging.Interfaces.ILogComponent"/> of the calling <see cref="T:System.Reflection.Assembly"/> and the <see cref="T:GBase.Logging.LogLevels"/> to the set <see cref="T:GBase.Logging.Interfaces.ILogger"/>s
+            </summary>
+            <param name="logLevel">The <see cref="T:GBase.Logging.LogLevels"/></param>
+            <param name="line">The given <see cref="T:System.String"/></param>
+            <typeparam name="T">The <see cref="T:System.Type"/> of the caller</typeparam>
+        </member>
+        <member name="M:GBase.Logging.Log.Write(GBase.Logging.Interfaces.ILogComponent,GBase.Logging.LogLevels,System.String)">
+            <summary>
+            Write a given <see cref="T:System.String"/> with the <see cref="T:GBase.Logging.Interfaces.ILogComponent"/> and the <see cref="T:GBase.Logging.LogLevels"/> to the set <see cref="T:GBase.Logging.Interfaces.ILogger"/>s
+            </summary>
+            <param name="component">The <see cref="T:GBase.Logging.Interfaces.ILogComponent"/></param>
+            <param name="logLevel">The <see cref="T:GBase.Logging.LogLevels"/></param>
+            <param name="line">The given <see cref="T:System.String"/></param>
+        </member>
+        <member name="M:GBase.Logging.Log.GetDefaultComponentFromType``1">
+            <summary>
+            Get the default <see cref="T:GBase.Logging.Interfaces.ILogComponent"/> for the given <see cref="T:System.Reflection.Assembly"/>
+            </summary>
+            <typeparam name="T">The <see cref="T:System.Type"/></typeparam>
+            <returns></returns>
+        </member>
+        <member name="M:GBase.Logging.Log.DisposeAsync">
+            <summary>
+            <see cref="M:GBase.Logging.Log.DisposeAsync"/> the <see cref="T:GBase.Logging.Log"/>
+            </summary>
+        </member>
+        <member name="E:GBase.Logging.Log.LogLevelChanged">
+            <summary>
+            Event that is fired when <see cref="M:GBase.Logging.Log.SetLogLevel(GBase.Logging.LogLevels)"/> is called
+            <para><see cref="T:System.EventArgs"/> is the newly set <see cref="T:GBase.Logging.LogLevels"/></para>
+            </summary>
+        </member>
+        <member name="T:GBase.Logging.LogComponentAttribute">
+            <summary>
+            The <see cref="T:GBase.Logging.Interfaces.ILogComponent"/> attribute
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.LogComponentAttribute.#ctor(System.String)">
+            <summary>
+            <see cref="T:GBase.Logging.LogComponentAttribute"/> constructor
+            </summary>
+            <param name="component">The <see cref="P:GBase.Logging.LogComponentAttribute.Component"/></param>
+        </member>
+        <member name="P:GBase.Logging.LogComponentAttribute.Component">
+            <summary>
+            The <see cref="P:GBase.Logging.LogComponentAttribute.Component"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.LogComponentAttribute.ToString">
+            <summary>
+            Returns the <see cref="P:GBase.Logging.LogComponentAttribute.Component"/> of this <see cref="T:GBase.Logging.Interfaces.ILogComponent"/>
+            </summary>
+            <returns>The <see cref="P:GBase.Logging.LogComponentAttribute.Component"/></returns>
+        </member>
+        <member name="T:GBase.Logging.LogLevels">
+            <summary>
+            The available <see cref="T:GBase.Logging.LogLevels"/>
+            </summary>
+        </member>
+        <member name="F:GBase.Logging.LogLevels.None">
+            <summary>
+            No logging 
+            </summary>
+        </member>
+        <member name="F:GBase.Logging.LogLevels.Error">
+            <summary>
+            Error logging
+            </summary>
+        </member>
+        <member name="F:GBase.Logging.LogLevels.Default">
+            <summary>
+            Default logging
+            </summary>
+        </member>
+        <member name="F:GBase.Logging.LogLevels.Advanced">
+            <summary>
+            Advanced logging
+            </summary>
+        </member>
+        <member name="F:GBase.Logging.LogLevels.Debug">
+            <summary>
+            Debug logging
+            </summary>
+        </member>
+        <member name="T:GBase.Logging.LogMessage">
+            <summary>
+            Implementation of <see cref="T:GBase.Logging.Interfaces.ILogMessage"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.LogMessage.LogLevel">
+            <summary>
+            The <see cref="T:GBase.Logging.LogLevels"/> of the <see cref="T:GBase.Logging.LogMessage"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.LogMessage.Timestamp">
+            <summary>
+            The <see cref="P:GBase.Logging.LogMessage.Timestamp"/> of the <see cref="T:GBase.Logging.LogMessage"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.LogMessage.Component">
+            <summary>
+            The <see cref="T:GBase.Logging.Interfaces.ILogComponent"/> of the <see cref="T:GBase.Logging.LogMessage"/>
+            </summary>
+        </member>
+        <member name="P:GBase.Logging.LogMessage.Message">
+            <summary>
+            The <see cref="P:GBase.Logging.LogMessage.Message"/> of the <see cref="T:GBase.Logging.LogMessage"/>
+            </summary>
+        </member>
+        <member name="M:GBase.Logging.LogMessage.ToString">
+            <summary>
+            Builds the <see cref="T:GBase.Logging.LogMessage"/> out of all parts and returns it as a <see cref="T:System.String"/>
+            </summary>
+            <returns>The <see cref="T:GBase.Logging.LogMessage"/> as a <see cref="T:System.String"/></returns>
+        </member>
+    </members>
+</doc>

GBase.Logging/Installers/LoggingInstaller.cs

@@ -10,8 +10,12 @@ using LightweightIocContainer.Interfaces.Installers;
 
 namespace GBase.Logging.Installers
 {
+    /// <summary>
+    /// <see cref="IIocInstaller"/> for the logging
+    /// </summary>
     public class LoggingInstaller : IIocInstaller
     {
+        /// <inheritdoc />
         public void Install(IIocContainer container)
         {
             container.Register<ILog, Log>();

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
 {
+    /// <summary>
+    /// An <see cref="ILogger"/> that writes log messages to the <see cref="Console"/>
+    /// </summary>
     public interface IConsoleLogger : ILogger
     {
         

GBase.Logging/Interfaces/IFileLogger.cs

@@ -4,6 +4,9 @@
 
 namespace GBase.Logging.Interfaces
 {
+    /// <summary>
+    /// An <see cref="ILogger"/> that writes log messages to a set file
+    /// </summary>
     public interface IFileLogger : ILogger
     {