From 2425099985f1c5e99a8d7dc17c38b30427a62d31 Mon Sep 17 00:00:00 2001
From: "Santhosh Reddy Vootukuri (SUNNY)" <nagavo@microsoft.com>
Date: Mon, 5 Jan 2026 17:12:35 -0800
Subject: [PATCH] Add XML documentation to core classes and methods

Improved code readability by adding XML documentation comments to
GenericConnection, MacOSHelper, and MicrocksContainerEnsemble.
These comments clarify the purpose and usage of properties,
constructors, and configuration methods. No functional changes
were made.

Signed-off-by: Santhosh Reddy Vootukuri (SUNNY) <nagavo@microsoft.com>
---
 .../Connection/GenericConnection.cs           | 20 +++++++++++
 .../Helpers/MacOSHelper.cs                    |  3 ++
 .../MicrocksContainerEnsemble.cs              | 33 +++++++++++++++++++
 3 files changed, 56 insertions(+)

diff --git a/src/Microcks.Testcontainers/Connection/GenericConnection.cs b/src/Microcks.Testcontainers/Connection/GenericConnection.cs
index 5655159..397006c 100644
--- a/src/Microcks.Testcontainers/Connection/GenericConnection.cs
+++ b/src/Microcks.Testcontainers/Connection/GenericConnection.cs
@@ -17,12 +17,32 @@
 
 namespace Microcks.Testcontainers.Connection;
 
+/// <summary>
+/// Represents generic connection information (URL and optional credentials).
+/// </summary>
 public class GenericConnection
 {
+    /// <summary>
+    /// Gets the connection URL.
+    /// </summary>
     public string Url { get; }
+
+    /// <summary>
+    /// Gets the username used for authentication, if any.
+    /// </summary>
     public string Username { get; }
+
+    /// <summary>
+    /// Gets the password used for authentication, if any.
+    /// </summary>
     public string Password { get; }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="GenericConnection"/> class.
+    /// </summary>
+    /// <param name="url">The connection URL.</param>
+    /// <param name="username">The username used for authentication, if any.</param>
+    /// <param name="password">The password used for authentication, if any.</param>
     public GenericConnection(string url, string username = null, string password = null)
     {
         Url = url;
diff --git a/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs b/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs
index 1a63238..c7e2000 100644
--- a/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs
+++ b/src/Microcks.Testcontainers/Helpers/MacOSHelper.cs
@@ -28,6 +28,9 @@ namespace Microcks.Testcontainers.Helpers;
 /// </summary>
 public static class MacOSHelper
 {
+    /// <summary>
+    /// Gets a value indicating whether the current process is running on macOS (Darwin) on Arm64.
+    /// </summary>
     public static bool IsMacOS { get; internal set; }
         = RuntimeInformation.ProcessArchitecture == Architecture.Arm64
           && RuntimeInformation.OSDescription.Contains("Darwin");
diff --git a/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs b/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs
index 113010a..fe1422c 100644
--- a/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs
+++ b/src/Microcks.Testcontainers/MicrocksContainerEnsemble.cs
@@ -51,6 +51,9 @@ public class MicrocksContainerEnsemble : IAsyncDisposable, IArtifactAndSnapshotM
 
     private readonly INetwork _network;
 
+    /// <summary>
+    /// Gets the Docker network used by this ensemble.
+    /// </summary>
     public INetwork Network { get => this._network; }
 
 
@@ -98,36 +101,66 @@ public MicrocksContainerEnsemble WithMainArtifacts(params string[] mainArtifacts
         return this;
     }
 
+    /// <summary>
+    /// Configures the Microcks container ensemble with the specified main remote artifacts.
+    /// </summary>
+    /// <param name="mainRemoteArtifacts">An array of remote artifact URIs/locations to be used by the Microcks container.</param>
+    /// <returns>The updated <see cref="MicrocksContainerEnsemble"/> instance.</returns>
     public MicrocksContainerEnsemble WithMainRemoteArtifacts(params string[] mainRemoteArtifacts)
     {
         this._microcksBuilder.WithMainRemoteArtifacts(mainRemoteArtifacts);
         return this;
     }
 
+    /// <summary>
+    /// Configures the Microcks container ensemble with the specified main remote artifacts.
+    /// </summary>
+    /// <param name="remoteArtifacts">The remote artifact definitions to be used by the Microcks container.</param>
+    /// <returns>The updated <see cref="MicrocksContainerEnsemble"/> instance.</returns>
     public MicrocksContainerEnsemble WithMainRemoteArtifacts(params RemoteArtifact[] remoteArtifacts)
     {
         this._microcksBuilder.WithMainRemoteArtifacts(remoteArtifacts);
         return this;
     }
 
+    /// <summary>
+    /// Configures the Microcks container ensemble with the specified secondary artifacts.
+    /// </summary>
+    /// <param name="secondaryArtifacts">An array of secondary artifact file names to be used by the Microcks container.</param>
+    /// <returns>The updated <see cref="MicrocksContainerEnsemble"/> instance.</returns>
     public MicrocksContainerEnsemble WithSecondaryArtifacts(params string[] secondaryArtifacts)
     {
         this._microcksBuilder.WithSecondaryArtifacts(secondaryArtifacts);
         return this;
     }
 
+    /// <summary>
+    /// Configures the Microcks container ensemble with the specified secondary remote artifacts.
+    /// </summary>
+    /// <param name="remoteArtifacts">The remote artifact definitions to be used by the Microcks container.</param>
+    /// <returns>The updated <see cref="MicrocksContainerEnsemble"/> instance.</returns>
     public MicrocksContainerEnsemble WithSecondaryRemoteArtifacts(params RemoteArtifact[] remoteArtifacts)
     {
         this._microcksBuilder.WithSecondaryRemoteArtifacts(remoteArtifacts);
         return this;
     }
 
+    /// <summary>
+    /// Configures the Microcks container ensemble with the specified snapshots.
+    /// </summary>
+    /// <param name="snapshots">An array of snapshot file names to be loaded into the Microcks container.</param>
+    /// <returns>The updated <see cref="MicrocksContainerEnsemble"/> instance.</returns>
     public MicrocksContainerEnsemble WithSnapshots(params string[] snapshots)
     {
         this._microcksBuilder.WithSnapshots(snapshots);
         return this;
     }
 
+    /// <summary>
+    /// Configures the Microcks container ensemble with the specified secrets.
+    /// </summary>
+    /// <param name="secrets">The secrets to create in the Microcks container.</param>
+    /// <returns>The updated <see cref="MicrocksContainerEnsemble"/> instance.</returns>
     public MicrocksContainerEnsemble WithSecrets(params Model.Secret[] secrets)
     {
         this._microcksBuilder.WithSecrets(secrets);