Update documentation after commit 5e1be3e

masesgroup · Oct 11, 2023 · f0e7d32 · f0e7d32
1 parent 5e1be3e
commit f0e7d32
Show file tree

Hide file tree

Showing 67 changed files with 1,182 additions and 750 deletions.
diff --git a/...S.EntityFrameworkCore.KNet.Design.Internal.KafkaCSharpRuntimeAnnotationCodeGenerator.html b/...S.EntityFrameworkCore.KNet.Design.Internal.KafkaCSharpRuntimeAnnotationCodeGenerator.html
@@ -73,7 +73,11 @@
 
   <h1 id="MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaCSharpRuntimeAnnotationCodeGenerator" data-uid="MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaCSharpRuntimeAnnotationCodeGenerator" class="text-break">Class KafkaCSharpRuntimeAnnotationCodeGenerator
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+the same compatibility standards as public APIs. It may be changed or removed without notice in
+any release. You should only use it directly in your code with extreme caution and knowing that
+doing so can result in application failures when updating to a new Entity Framework Core release.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -167,7 +171,7 @@ <h3 id="constructors">Constructors
     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaCSharpRuntimeAnnotationCodeGenerator__ctor_Microsoft_EntityFrameworkCore_Design_Internal_CSharpRuntimeAnnotationCodeGeneratorDependencies_.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaCSharpRuntimeAnnotationCodeGenerator.%23ctor(Microsoft.EntityFrameworkCore.Design.Internal.CSharpRuntimeAnnotationCodeGeneratorDependencies)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Design/Internal/KafkaCSharpRuntimeAnnotationCodeGenerator.cs/#L29">View Source</a>
+    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Design/Internal/KafkaCSharpRuntimeAnnotationCodeGenerator.cs/#L35">View Source</a>
   </span>
   <a id="MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaCSharpRuntimeAnnotationCodeGenerator__ctor_" data-uid="MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaCSharpRuntimeAnnotationCodeGenerator.#ctor*"></a>
   <h4 id="MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaCSharpRuntimeAnnotationCodeGenerator__ctor_Microsoft_EntityFrameworkCore_Design_Internal_CSharpRuntimeAnnotationCodeGeneratorDependencies_" data-uid="MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaCSharpRuntimeAnnotationCodeGenerator.#ctor(Microsoft.EntityFrameworkCore.Design.Internal.CSharpRuntimeAnnotationCodeGeneratorDependencies)">KafkaCSharpRuntimeAnnotationCodeGenerator(CSharpRuntimeAnnotationCodeGeneratorDependencies)</h4>
@@ -209,7 +213,7 @@ <h3 id="implements">Implements</h3>
                     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaCSharpRuntimeAnnotationCodeGenerator.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaCSharpRuntimeAnnotationCodeGenerator%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                   </li>
                   <li>
-                    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Design/Internal/KafkaCSharpRuntimeAnnotationCodeGenerator.cs/#L27" class="contribution-link">View Source</a>
+                    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Design/Internal/KafkaCSharpRuntimeAnnotationCodeGenerator.cs/#L33" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>

diff --git a/docs/api/MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaDesignTimeServices.html b/docs/api/MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaDesignTimeServices.html
@@ -73,7 +73,11 @@
 
   <h1 id="MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaDesignTimeServices" data-uid="MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaDesignTimeServices" class="text-break">Class KafkaDesignTimeServices
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+the same compatibility standards as public APIs. It may be changed or removed without notice in
+any release. You should only use it directly in your code with extreme caution and knowing that
+doing so can result in application failures when updating to a new Entity Framework Core release.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -93,7 +97,7 @@ <h3 id="methods">Methods
     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaDesignTimeServices_ConfigureDesignTimeServices_IServiceCollection_.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaDesignTimeServices.ConfigureDesignTimeServices(IServiceCollection)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Design/Internal/KafkaDesignTimeServices.cs/#L30">View Source</a>
+    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Design/Internal/KafkaDesignTimeServices.cs/#L35">View Source</a>
   </span>
   <a id="MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaDesignTimeServices_ConfigureDesignTimeServices_" data-uid="MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaDesignTimeServices.ConfigureDesignTimeServices*"></a>
   <h4 id="MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaDesignTimeServices_ConfigureDesignTimeServices_IServiceCollection_" data-uid="MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaDesignTimeServices.ConfigureDesignTimeServices(IServiceCollection)">ConfigureDesignTimeServices(IServiceCollection)</h4>
@@ -131,7 +135,7 @@ <h5 class="parameters">Parameters</h5>
                     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Design_Internal_KafkaDesignTimeServices.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaDesignTimeServices%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                   </li>
                   <li>
-                    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Design/Internal/KafkaDesignTimeServices.cs/#L28" class="contribution-link">View Source</a>
+                    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Design/Internal/KafkaDesignTimeServices.cs/#L33" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>

diff --git a/docs/api/MASES.EntityFrameworkCore.KNet.Design.Internal.html b/docs/api/MASES.EntityFrameworkCore.KNet.Design.Internal.html
@@ -78,9 +78,17 @@ <h1 id="MASES_EntityFrameworkCore_KNet_Design_Internal" data-uid="MASES.EntityFr
     <h3 id="classes">Classes
   </h3>
       <h4><a class="xref" href="MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaCSharpRuntimeAnnotationCodeGenerator.html">KafkaCSharpRuntimeAnnotationCodeGenerator</a></h4>
-      <section></section>
+      <section><p>This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+the same compatibility standards as public APIs. It may be changed or removed without notice in
+any release. You should only use it directly in your code with extreme caution and knowing that
+doing so can result in application failures when updating to a new Entity Framework Core release.</p>
+</section>
       <h4><a class="xref" href="MASES.EntityFrameworkCore.KNet.Design.Internal.KafkaDesignTimeServices.html">KafkaDesignTimeServices</a></h4>
-      <section></section>
+      <section><p>This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+the same compatibility standards as public APIs. It may be changed or removed without notice in
+any release. You should only use it directly in your code with extreme caution and knowing that
+doing so can result in application failures when updating to a new Entity Framework Core release.</p>
+</section>
 </article>
           </div>
 

diff --git a/docs/api/MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions.html b/docs/api/MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions.html
@@ -73,7 +73,11 @@
 
   <h1 id="MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggerExtensions" data-uid="MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions" class="text-break">Class KafkaLoggerExtensions
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+the same compatibility standards as public APIs. It may be changed or removed without notice in
+any release. You should only use it directly in your code with extreme caution and knowing that
+doing so can result in application failures when updating to a new Entity Framework Core release.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -117,7 +121,7 @@ <h3 id="methods">Methods
     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggerExtensions_ChangesSaved_IDiagnosticsLogger_DbLoggerCategory_Update__IEnumerable_IUpdateEntry__System_Int32_.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions.ChangesSaved(IDiagnosticsLogger%7BDbLoggerCategory.Update%7D%2CIEnumerable%7BIUpdateEntry%7D%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggerExtensions.cs/#L48">View Source</a>
+    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggerExtensions.cs/#L53">View Source</a>
   </span>
   <a id="MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggerExtensions_ChangesSaved_" data-uid="MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions.ChangesSaved*"></a>
   <h4 id="MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggerExtensions_ChangesSaved_IDiagnosticsLogger_DbLoggerCategory_Update__IEnumerable_IUpdateEntry__System_Int32_" data-uid="MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions.ChangesSaved(IDiagnosticsLogger{DbLoggerCategory.Update},IEnumerable{IUpdateEntry},System.Int32)">ChangesSaved(IDiagnosticsLogger&lt;DbLoggerCategory.Update&gt;, IEnumerable&lt;IUpdateEntry&gt;, Int32)</h4>
@@ -159,7 +163,7 @@ <h5 class="parameters">Parameters</h5>
     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggerExtensions_TransactionIgnoredWarning_IDiagnosticsLogger_DbLoggerCategory_Database_Transaction__.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions.TransactionIgnoredWarning(IDiagnosticsLogger%7BDbLoggerCategory.Database.Transaction%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggerExtensions.cs/#L28">View Source</a>
+    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggerExtensions.cs/#L33">View Source</a>
   </span>
   <a id="MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggerExtensions_TransactionIgnoredWarning_" data-uid="MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions.TransactionIgnoredWarning*"></a>
   <h4 id="MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggerExtensions_TransactionIgnoredWarning_IDiagnosticsLogger_DbLoggerCategory_Database_Transaction__" data-uid="MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions.TransactionIgnoredWarning(IDiagnosticsLogger{DbLoggerCategory.Database.Transaction})">TransactionIgnoredWarning(IDiagnosticsLogger&lt;DbLoggerCategory.Database.Transaction&gt;)</h4>
@@ -197,7 +201,7 @@ <h5 class="parameters">Parameters</h5>
                     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggerExtensions.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggerExtensions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                   </li>
                   <li>
-                    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggerExtensions.cs/#L26" class="contribution-link">View Source</a>
+                    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggerExtensions.cs/#L31" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>

diff --git a/docs/api/MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggingDefinitions.html b/docs/api/MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggingDefinitions.html
@@ -73,7 +73,11 @@
 
   <h1 id="MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggingDefinitions" data-uid="MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggingDefinitions" class="text-break">Class KafkaLoggingDefinitions
   </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>This is an internal API that supports the Entity Framework Core infrastructure and not subject to
+the same compatibility standards as public APIs. It may be changed or removed without notice in
+any release. You should only use it directly in your code with extreme caution and knowing that
+doing so can result in application failures when updating to a new Entity Framework Core release.</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -93,7 +97,7 @@ <h3 id="fields">Fields
     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggingDefinitions_LogSavedChanges.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggingDefinitions.LogSavedChanges%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggingDefinitions.cs/#L26">View Source</a>
+    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggingDefinitions.cs/#L31">View Source</a>
   </span>
   <h4 id="MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggingDefinitions_LogSavedChanges" data-uid="MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggingDefinitions.LogSavedChanges">LogSavedChanges</h4>
   <div class="markdown level1 summary"></div>
@@ -112,7 +116,7 @@ <h5 class="fieldValue">Field Value</h5>
     </thead>
     <tbody>
       <tr>
-        <td><span class="xref">System.Nullable</span>&lt;<span class="xref">EventDefinitionBase</span>&gt;</td>
+        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<span class="xref">EventDefinitionBase</span>&gt;</td>
         <td></td>
       </tr>
     </tbody>
@@ -122,7 +126,7 @@ <h5 class="fieldValue">Field Value</h5>
     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggingDefinitions_LogTransactionsNotSupported.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggingDefinitions.LogTransactionsNotSupported%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggingDefinitions.cs/#L28">View Source</a>
+    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggingDefinitions.cs/#L33">View Source</a>
   </span>
   <h4 id="MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggingDefinitions_LogTransactionsNotSupported" data-uid="MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggingDefinitions.LogTransactionsNotSupported">LogTransactionsNotSupported</h4>
   <div class="markdown level1 summary"></div>
@@ -141,7 +145,7 @@ <h5 class="fieldValue">Field Value</h5>
     </thead>
     <tbody>
       <tr>
-        <td><span class="xref">System.Nullable</span>&lt;<span class="xref">EventDefinitionBase</span>&gt;</td>
+        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<span class="xref">EventDefinitionBase</span>&gt;</td>
         <td></td>
       </tr>
     </tbody>
@@ -157,7 +161,7 @@ <h5 class="fieldValue">Field Value</h5>
                     <a href="https://github.com/masesgroup/KEFCore/new/master/apiSpec/new?filename=MASES_EntityFrameworkCore_KNet_Diagnostics_Internal_KafkaLoggingDefinitions.md&amp;value=---%0Auid%3A%20MASES.EntityFrameworkCore.KNet.Diagnostics.Internal.KafkaLoggingDefinitions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                   </li>
                   <li>
-                    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggingDefinitions.cs/#L24" class="contribution-link">View Source</a>
+                    <a href="https://github.com/masesgroup/KEFCore/blob/master/src/net/KEFCore/Diagnostics/Internal/KafkaLoggingDefinitions.cs/#L29" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>