Added missing code documentation

Author: egil

src/Asserting/ShouldBeTextChangeAssertExtensions.cs

@@ -15,11 +15,23 @@ namespace Egil.RazorComponents.Testing.Asserting
     /// </summary>
     public static class ShouldBeTextChangeAssertExtensions
     {
+        /// <summary>
+        /// Verifies that a list of diffs contains only a single change, and that change is a change to a text node.
+        /// </summary>
+        /// <param name="diffs">The list of diffs to verify against.</param>
+        /// <param name="expectedChange">The expected text change.</param>
+        /// <param name="userMessage">A custom error message to show if the verification fails.</param>
         public static void ShouldHaveSingleTextChange(this IReadOnlyList<IDiff> diffs, string expectedChange, string? userMessage = null)
         {
             DiffAssertExtensions.ShouldHaveSingleChange(diffs).ShouldBeTextChange(expectedChange, userMessage);
         }
 
+        /// <summary>
+        /// Verifies that a diff is a change to a text node.
+        /// </summary>
+        /// <param name="actualChange">The diff to verify.</param>
+        /// <param name="expectedChange">The expected text change.</param>
+        /// <param name="userMessage">A custom error message to show if the verification fails.</param>
         public static void ShouldBeTextChange(this IDiff actualChange, string expectedChange, string? userMessage = null)
         {
             if (actualChange is null) throw new ArgumentNullException(nameof(actualChange));
@@ -32,12 +44,24 @@ public static void ShouldBeTextChange(this IDiff actualChange, string expectedCh
             ShouldBeTextChange(actualChange, expected, userMessage);
         }
 
+        /// <summary>
+        /// Verifies that a diff is a change to a text node.
+        /// </summary>
+        /// <param name="actualChange">The diff to verify.</param>
+        /// <param name="expectedChange">The rendered fragment containing the expected text change.</param>
+        /// <param name="userMessage">A custom error message to show if the verification fails.</param>
         public static void ShouldBeTextChange(this IDiff actualChange, IRenderedFragment expectedChange, string? userMessage = null)
         {
             if (expectedChange is null) throw new ArgumentNullException(nameof(expectedChange));
             ShouldBeTextChange(actualChange, expectedChange.GetNodes(), userMessage);
         }
 
+        /// <summary>
+        /// Verifies that a diff is a change to a text node.
+        /// </summary>
+        /// <param name="actualChange">The diff to verify.</param>
+        /// <param name="expectedChange">The node list containing the expected text change.</param>
+        /// <param name="userMessage">A custom error message to show if the verification fails.</param>
         public static void ShouldBeTextChange(this IDiff actualChange, INodeList expectedChange, string? userMessage = null)
         {
             if (actualChange is null) throw new ArgumentNullException(nameof(actualChange));

src/Components/ComponentUnderTest.cs

@@ -4,9 +4,13 @@
 
 namespace Egil.RazorComponents.Testing
 {
-
+    /// <summary>
+    /// Represents a component that can be added inside a <see cref="Fixture"/>,
+    /// where a component under test can be defined as the child content.
+    /// </summary>
     public class ComponentUnderTest : FragmentBase
     {
+        /// <inheritdoc />
         public override Task SetParametersAsync(ParameterView parameters)
         {
             var result = base.SetParametersAsync(parameters);

src/Components/Fragment.cs

@@ -2,8 +2,16 @@
 
 namespace Egil.RazorComponents.Testing
 {
+    /// <summary>
+    /// Represents a component that can be added inside a <see cref="Fixture"/>, whose content
+    /// can be accessed in Razor-based test.
+    /// </summary>
     public class Fragment : FragmentBase
     {
+        /// <summary>
+        /// Gets or sets the id of the fragment. The <see cref="Id"/> can be used to retrieve 
+        /// the fragment from a <see cref="IRazorTestContext.GetFragment(string)"/>.
+        /// </summary>
         [Parameter] public string Id { get; set; } = string.Empty;
     }
 }

src/Components/FragmentBase.cs

@@ -4,12 +4,20 @@
 
 namespace Egil.RazorComponents.Testing
 {
+    /// <summary>
+    /// Represents a fragment that can be used in <see cref="SnapshotTest"/> or <see cref="Fixture"/>.
+    /// </summary>
     public abstract class FragmentBase : IComponent
     {
+        /// <summary>
+        /// Gets or sets the child content of the fragment.
+        /// </summary>
         [Parameter] public RenderFragment ChildContent { get; set; } = default!;
 
+        /// <inheritdoc />
         public void Attach(RenderHandle renderHandle) { }
 
+        /// <inheritdoc />
         public virtual Task SetParametersAsync(ParameterView parameters)
         {
             parameters.SetParameterProperties(this);

src/Diffing/BlazorDiffingHelpers.cs

@@ -3,8 +3,14 @@
 
 namespace Egil.RazorComponents.Testing.Diffing
 {
+    /// <summary>
+    /// Blazor Dffing Helpers
+    /// </summary>
     public static class BlazorDiffingHelpers
     {
+        /// <summary>
+        /// Represents a diffing filter that removes all special Blazor attributes added by the <see cref="TestRenderer"/>/<see cref="Htmlizer"/>.
+        /// </summary>
         public static FilterDecision BlazorEventHandlerIdAttrFilter(in AttributeComparisonSource attrSource, FilterDecision currentDecision)
         {
             if (currentDecision == FilterDecision.Exclude) return currentDecision;

src/Diffing/DiffMarkupFormatter.cs

@@ -5,6 +5,9 @@
 
 namespace Egil.RazorComponents.Testing.Diffing
 {
+    /// <summary>
+    /// A markup formatter, that skips any special Blazor attributes added by the <see cref="TestRenderer"/>/<see cref="Htmlizer"/>.
+    /// </summary>
     public class DiffMarkupFormatter : IMarkupFormatter
     {
         private readonly IMarkupFormatter _formatter = new PrettyMarkupFormatter()
@@ -13,14 +16,22 @@ public class DiffMarkupFormatter : IMarkupFormatter
             Indentation = "  "
         };
 
+        /// <inheritdoc />
         public string Attribute(IAttr attribute)
             => Htmlizer.IsBlazorAttribute(attribute?.Name ?? string.Empty)
                 ? string.Empty
                 : _formatter.Attribute(attribute);
 
+        /// <inheritdoc />
         public string CloseTag(IElement element, bool selfClosing) => _formatter.CloseTag(element, selfClosing);
+        
+        /// <inheritdoc />
         public string Comment(IComment comment) => _formatter.Comment(comment);
+        
+        /// <inheritdoc />
         public string Doctype(IDocumentType doctype) => _formatter.Doctype(doctype);
+
+        /// <inheritdoc />
         public string OpenTag(IElement element, bool selfClosing)
         {
             if(element is null) throw new ArgumentNullException(nameof(element));
@@ -39,7 +50,10 @@ public string OpenTag(IElement element, bool selfClosing)
             return result;
         }
 
+        /// <inheritdoc />
         public string Processing(IProcessingInstruction processing) => _formatter.Processing(processing);
+
+        /// <inheritdoc />
         public string Text(ICharacterData text) => _formatter.Text(text);
     }
 }