Add XML documentation to Umbrella.Testing.Architecture public API

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Author: ricardoeduardo

Testing/src/Umbrella.Testing.Architecture/Umbrella.Testing.Architecture.csproj

@@ -4,7 +4,7 @@
 		<TargetFramework>net8.0</TargetFramework>
 		<PackageId>Umbrella.Testing.Architecture</PackageId>
 		<Description>Abstract base test classes enforcing Umbrella layer dependency and implementation visibility rules using NetArchTest.Rules and xunit.v3</Description>
-		<NoWarn>$(NoWarn);CA1707;CS1591</NoWarn>
+		<NoWarn>$(NoWarn);CA1707</NoWarn>
 	</PropertyGroup>
 
 	<ItemGroup>

Testing/src/Umbrella.Testing.Architecture/UmbrellaImplementationVisibilityTests.cs

@@ -4,11 +4,27 @@
 
 namespace Umbrella.Testing.Architecture;
 
+/// <summary>
+/// Abstract base class providing xunit.v3 tests that enforce <c>internal sealed</c> visibility
+/// on all concrete repository, service, file-handler, and authorization-handler implementations.
+/// </summary>
+/// <remarks>
+/// Inherit from this class and override the abstract <see cref="CoreLogic"/> property.
+/// Override <see cref="CoreData"/> if the project has a data layer; tests for absent layers
+/// are reported as skipped rather than failed.
+/// </remarks>
 public abstract class UmbrellaImplementationVisibilityTests
 {
+    /// <summary>
+    /// Gets the assembly for the <c>Core.Data</c> layer, or <see langword="null"/> if the project
+    /// has no data layer (e.g. Optimizely sites that rely on Remarkable.Optimizely packages).
+    /// </summary>
     protected virtual Assembly? CoreData => null;
+
+    /// <summary>Gets the assembly for the <c>Core.Logic</c> layer.</summary>
     protected abstract Assembly CoreLogic { get; }
 
+    /// <summary>Verifies that all classes named <c>*Repository</c> in <c>Core.Data</c> are <c>internal sealed</c>.</summary>
     [Fact]
     public void CoreData_Repositories_AreInternalSealed()
     {
@@ -18,14 +34,17 @@ public void CoreData_Repositories_AreInternalSealed()
         AssertInternalSealed(CoreData, "Repository$");
     }
 
+    /// <summary>Verifies that all classes named <c>*Service</c> in <c>Core.Logic</c> are <c>internal sealed</c>.</summary>
     [Fact]
     public void CoreLogic_Services_AreInternalSealed() =>
         AssertInternalSealed(CoreLogic, "Service$");
 
+    /// <summary>Verifies that all classes named <c>*FileHandler</c> in <c>Core.Logic</c> are <c>internal sealed</c>.</summary>
     [Fact]
     public void CoreLogic_FileHandlers_AreInternalSealed() =>
         AssertInternalSealed(CoreLogic, "FileHandler$");
 
+    /// <summary>Verifies that all classes named <c>*AuthorizationHandler</c> in <c>Core.Logic</c> are <c>internal sealed</c>.</summary>
     [Fact]
     public void CoreLogic_AuthorizationHandlers_AreInternalSealed() =>
         AssertInternalSealed(CoreLogic, "AuthorizationHandler$");

Testing/src/Umbrella.Testing.Architecture/UmbrellaLayerDependencyTests.cs

@@ -4,17 +4,55 @@
 
 namespace Umbrella.Testing.Architecture;
 
+/// <summary>
+/// Abstract base class providing xunit.v3 tests that enforce layer dependency direction
+/// across the standard Umbrella project structure.
+/// </summary>
+/// <remarks>
+/// Inherit from this class and override the abstract properties to supply the assembly
+/// for each layer. Optional layers (<see cref="CoreData"/>, <see cref="WebServerModels"/>,
+/// <see cref="WebServerModelFactories"/>, <see cref="WebShared"/>, <see cref="WebClientData"/>)
+/// default to <see langword="null"/>; tests for absent layers are reported as skipped rather
+/// than failed.
+/// </remarks>
 public abstract class UmbrellaLayerDependencyTests
 {
+    /// <summary>Gets the root namespace prefix for the project (e.g. <c>"IndyRecords"</c>).</summary>
     protected abstract string NamespacePrefix { get; }
+
+    /// <summary>Gets the assembly for the <c>Core.Domain</c> layer.</summary>
     protected abstract Assembly CoreDomain { get; }
+
+    /// <summary>
+    /// Gets the assembly for the <c>Core.Data</c> layer, or <see langword="null"/> if the project
+    /// has no data layer (e.g. Optimizely sites that rely on Remarkable.Optimizely packages).
+    /// </summary>
     protected virtual Assembly? CoreData => null;
+
+    /// <summary>Gets the assembly for the <c>Core.Logic</c> layer.</summary>
     protected abstract Assembly CoreLogic { get; }
+
+    /// <summary>
+    /// Gets the assembly for the <c>Web.Server.Models</c> layer, or <see langword="null"/> if absent.
+    /// </summary>
     protected virtual Assembly? WebServerModels => null;
+
+    /// <summary>
+    /// Gets the assembly for the <c>Web.Server.ModelFactories</c> layer, or <see langword="null"/> if absent.
+    /// </summary>
     protected virtual Assembly? WebServerModelFactories => null;
+
+    /// <summary>
+    /// Gets the assembly for the <c>Web.Shared</c> layer, or <see langword="null"/> if absent.
+    /// </summary>
     protected virtual Assembly? WebShared => null;
+
+    /// <summary>
+    /// Gets the assembly for the <c>Web.Client.Data</c> layer, or <see langword="null"/> if absent.
+    /// </summary>
     protected virtual Assembly? WebClientData => null;
 
+    /// <summary>Verifies that <c>Core.Domain</c> does not reference <c>Core.Data</c>.</summary>
     [Fact]
     public void CoreDomain_DoesNotDependOnCoreData()
     {
@@ -24,14 +62,17 @@ public void CoreDomain_DoesNotDependOnCoreData()
         AssertNoDependency(CoreDomain, $"{NamespacePrefix}.Core.Data");
     }
 
+    /// <summary>Verifies that <c>Core.Domain</c> does not reference <c>Core.Logic</c>.</summary>
     [Fact]
     public void CoreDomain_DoesNotDependOnCoreLogic() =>
         AssertNoDependency(CoreDomain, $"{NamespacePrefix}.Core.Logic");
 
+    /// <summary>Verifies that <c>Core.Domain</c> does not reference any <c>Web</c> layer.</summary>
     [Fact]
     public void CoreDomain_DoesNotDependOnWebLayer() =>
         AssertNoDependency(CoreDomain, $"{NamespacePrefix}.Web");
 
+    /// <summary>Verifies that <c>Core.Data</c> does not reference <c>Core.Logic</c>.</summary>
     [Fact]
     public void CoreData_DoesNotDependOnCoreLogic()
     {
@@ -41,6 +82,7 @@ public void CoreData_DoesNotDependOnCoreLogic()
         AssertNoDependency(CoreData, $"{NamespacePrefix}.Core.Logic");
     }
 
+    /// <summary>Verifies that <c>Core.Data</c> does not reference any <c>Web</c> layer.</summary>
     [Fact]
     public void CoreData_DoesNotDependOnWebLayer()
     {
@@ -50,10 +92,12 @@ public void CoreData_DoesNotDependOnWebLayer()
         AssertNoDependency(CoreData, $"{NamespacePrefix}.Web");
     }
 
+    /// <summary>Verifies that <c>Core.Logic</c> does not reference any <c>Web</c> layer.</summary>
     [Fact]
     public void CoreLogic_DoesNotDependOnWebLayer() =>
         AssertNoDependency(CoreLogic, $"{NamespacePrefix}.Web");
 
+    /// <summary>Verifies that <c>Web.Server.Models</c> does not reference <c>Core.Logic</c>.</summary>
     [Fact]
     public void WebServerModels_DoesNotDependOnCoreLogic()
     {
@@ -63,6 +107,7 @@ public void WebServerModels_DoesNotDependOnCoreLogic()
         AssertNoDependency(WebServerModels, $"{NamespacePrefix}.Core.Logic");
     }
 
+    /// <summary>Verifies that <c>Web.Server.Models</c> does not reference <c>Core.Data</c>.</summary>
     [Fact]
     public void WebServerModels_DoesNotDependOnCoreData()
     {
@@ -72,6 +117,7 @@ public void WebServerModels_DoesNotDependOnCoreData()
         AssertNoDependency(WebServerModels, $"{NamespacePrefix}.Core.Data");
     }
 
+    /// <summary>Verifies that <c>Web.Shared</c> does not reference any <c>Core</c> layer.</summary>
     [Fact]
     public void WebShared_DoesNotDependOnCore()
     {
@@ -81,6 +127,7 @@ public void WebShared_DoesNotDependOnCore()
         AssertNoDependency(WebShared, $"{NamespacePrefix}.Core");
     }
 
+    /// <summary>Verifies that <c>Web.Client.Data</c> does not reference any <c>Core</c> layer.</summary>
     [Fact]
     public void WebClientData_DoesNotDependOnCore()
     {