Updated documentation to reflect latest changes 7a70f26

Aptivi · Dec 17, 2024 · 2450c85 · 2450c85
1 parent aa49211
commit 2450c85
Show file tree

Hide file tree

Showing 8 changed files with 85 additions and 71 deletions.
diff --git a/api/Aptivestigate.Log4Net.Log4NetLogger.html b/api/Aptivestigate.Log4Net.Log4NetLogger.html
diff --git a/api/Aptivestigate.Log4Net.html b/api/Aptivestigate.Log4Net.html
@@ -86,7 +86,8 @@ <h3 id="classes">
 Classes
 </h3>
       <h4><a class="xref" href="Aptivestigate.Log4Net.Log4NetLogger.html">Log4NetLogger</a></h4>
-      <section></section>
+      <section><p>Inherited logger class for Log4Net</p>
+</section>
 
 
 </article>

diff --git a/api/Aptivestigate.NLog.NLogLogger.html b/api/Aptivestigate.NLog.NLogLogger.html
@@ -9,7 +9,7 @@
       <meta name="viewport" content="width=device-width">
       <meta name="title" content="Class NLogLogger | Aptivestigate API - Aptivi ">
 
-
+    <meta name="description" content="Inherited logger class for NLog">
       <link rel="shortcut icon" href="../favicon.ico">
       <link rel="stylesheet" href="../styles/docfx.vendor.min.css">
       <link rel="stylesheet" href="../styles/docfx.css">
@@ -81,7 +81,8 @@
 
 
   <h1 id="Aptivestigate_NLog_NLogLogger" data-uid="Aptivestigate.NLog.NLogLogger" class="text-break">Class NLogLogger</h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>Inherited logger class for NLog</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -102,11 +103,12 @@ <h3 id="constructors">Constructors
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger__ctor_System_String_NLog_Config_LoggingConfiguration_.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.%23ctor(System.String%2CNLog.Config.LoggingConfiguration)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L93">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L156">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger__ctor_" data-uid="Aptivestigate.NLog.NLogLogger.#ctor*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger__ctor_System_String_NLog_Config_LoggingConfiguration_" data-uid="Aptivestigate.NLog.NLogLogger.#ctor(System.String,NLog.Config.LoggingConfiguration)">NLogLogger(string, LoggingConfiguration?)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Makes a new logger instance</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
   <div class="codewrapper">
@@ -125,12 +127,14 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><span class="xref">string</span></td>
         <td><span class="parametername">name</span></td>
-        <td></td>
+        <td><p>Context to log with</p>
+</td>
       </tr>
       <tr>
         <td><span class="xref">LoggingConfiguration</span></td>
         <td><span class="parametername">configurator</span></td>
-        <td></td>
+        <td><p>Configuration instance that configures NLog</p>
+</td>
       </tr>
     </tbody>
   </table>
@@ -141,7 +145,7 @@ <h3 id="methods">Methods
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Debug_System_Exception_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Debug(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L39">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L53">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Debug_" data-uid="Aptivestigate.NLog.NLogLogger.Debug*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Debug_System_Exception_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Debug(System.Exception,System.String,System.Object[])">Debug(Exception, string, params object?[]?)</h4>
@@ -189,7 +193,7 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Debug_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Debug(System.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L33">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L41">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Debug_" data-uid="Aptivestigate.NLog.NLogLogger.Debug*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Debug_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Debug(System.String,System.Object[])">Debug(string, params object?[]?)</h4>
@@ -231,7 +235,7 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Error_System_Exception_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Error(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L51">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L76">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Error_" data-uid="Aptivestigate.NLog.NLogLogger.Error*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Error_System_Exception_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Error(System.Exception,System.String,System.Object[])">Error(Exception, string, params object?[]?)</h4>
@@ -279,7 +283,7 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Error_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Error(System.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L45">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L64">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Error_" data-uid="Aptivestigate.NLog.NLogLogger.Error*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Error_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Error(System.String,System.Object[])">Error(string, params object?[]?)</h4>
@@ -321,7 +325,7 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Fatal_System_Exception_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Fatal(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L63">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L99">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Fatal_" data-uid="Aptivestigate.NLog.NLogLogger.Fatal*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Fatal_System_Exception_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Fatal(System.Exception,System.String,System.Object[])">Fatal(Exception, string, params object?[]?)</h4>
@@ -369,7 +373,7 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Fatal_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Fatal(System.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L57">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L87">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Fatal_" data-uid="Aptivestigate.NLog.NLogLogger.Fatal*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Fatal_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Fatal(System.String,System.Object[])">Fatal(string, params object?[]?)</h4>
@@ -411,7 +415,7 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Info_System_Exception_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Info(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L75">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L122">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Info_" data-uid="Aptivestigate.NLog.NLogLogger.Info*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Info_System_Exception_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Info(System.Exception,System.String,System.Object[])">Info(Exception, string, params object?[]?)</h4>
@@ -459,7 +463,7 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Info_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Info(System.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L69">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L110">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Info_" data-uid="Aptivestigate.NLog.NLogLogger.Info*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Info_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Info(System.String,System.Object[])">Info(string, params object?[]?)</h4>
@@ -501,7 +505,7 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Warning_System_Exception_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Warning(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L87">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L145">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Warning_" data-uid="Aptivestigate.NLog.NLogLogger.Warning*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Warning_System_Exception_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Warning(System.Exception,System.String,System.Object[])">Warning(Exception, string, params object?[]?)</h4>
@@ -549,7 +553,7 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger_Warning_System_String_System_Object___.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger.Warning(System.String%2CSystem.Object%5B%5D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L81">View Source</a>
+    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L133">View Source</a>
   </span>
   <a id="Aptivestigate_NLog_NLogLogger_Warning_" data-uid="Aptivestigate.NLog.NLogLogger.Warning*"></a>
   <h4 id="Aptivestigate_NLog_NLogLogger_Warning_System_String_System_Object___" data-uid="Aptivestigate.NLog.NLogLogger.Warning(System.String,System.Object[])">Warning(string, params object?[]?)</h4>
@@ -598,7 +602,7 @@ <h5 class="overrides">Overrides</h5>
                     <a href="https://github.com/Aptivi/Aptivestigate/new/main/apiSpec/new?filename=Aptivestigate_NLog_NLogLogger.md&amp;value=---%0Auid%3A%20Aptivestigate.NLog.NLogLogger%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
                   </li>
                   <li>
-                    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L28" class="contribution-link">View Source</a>
+                    <a href="https://github.com/Aptivi/Aptivestigate/blob/main/public/Aptivestigate.NLog/NLogLogger.cs/#L31" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>

diff --git a/api/Aptivestigate.NLog.html b/api/Aptivestigate.NLog.html
@@ -86,7 +86,8 @@ <h3 id="classes">
 Classes
 </h3>
       <h4><a class="xref" href="Aptivestigate.NLog.NLogLogger.html">NLogLogger</a></h4>
-      <section></section>
+      <section><p>Inherited logger class for NLog</p>
+</section>
 
 
 </article>