From ef3b2695f4faa601059b6f0b5c30d7bd11fc452c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9dric=20Luthi?= <cedric.luthi@gmail.com>
Date: Mon, 25 Nov 2024 23:47:37 +0100
Subject: [PATCH] Improve the XML documentation

---
 src/Testcontainers.Xunit/ContainerFixture.cs        | 1 +
 src/Testcontainers.Xunit/ContainerTest.cs           | 2 ++
 src/Testcontainers.Xunit/IDbContainerTestMethods.cs | 2 +-
 3 files changed, 4 insertions(+), 1 deletion(-)

diff --git a/src/Testcontainers.Xunit/ContainerFixture.cs b/src/Testcontainers.Xunit/ContainerFixture.cs
index 6558678dd..610216434 100644
--- a/src/Testcontainers.Xunit/ContainerFixture.cs
+++ b/src/Testcontainers.Xunit/ContainerFixture.cs
@@ -5,6 +5,7 @@ namespace Testcontainers.Xunit;
 /// See <a href="https://xunit.net/docs/shared-context">Shared Context between Tests</a> from xUnit.net documentation for more information about fixtures.
 /// A logger is automatically configured to write diagnostic messages to xUnit's <see cref="IMessageSink" />.
 /// </summary>
+/// <param name="messageSink">An optional <see cref="IMessageSink"/> where the logs are written to. Pass <c>null</c> to ignore logs.</param>
 /// <typeparam name="TBuilderEntity">The builder entity.</typeparam>
 /// <typeparam name="TContainerEntity">The container entity.</typeparam>
 [PublicAPI]
diff --git a/src/Testcontainers.Xunit/ContainerTest.cs b/src/Testcontainers.Xunit/ContainerTest.cs
index 10fa3bc16..be7519ff1 100644
--- a/src/Testcontainers.Xunit/ContainerTest.cs
+++ b/src/Testcontainers.Xunit/ContainerTest.cs
@@ -4,6 +4,8 @@ namespace Testcontainers.Xunit;
 /// Base class for tests needing a container per test method.
 /// A logger is automatically configured to write messages to xUnit's <see cref="ITestOutputHelper" />.
 /// </summary>
+/// <param name="testOutputHelper">An optional <see cref="ITestOutputHelper"/> where the logs are written to. Pass <c>null</c> to ignore logs.</param>
+/// <param name="configure">An optional callback to configure the container.</param>
 /// <typeparam name="TBuilderEntity">The builder entity.</typeparam>
 /// <typeparam name="TContainerEntity">The container entity.</typeparam>
 [PublicAPI]
diff --git a/src/Testcontainers.Xunit/IDbContainerTestMethods.cs b/src/Testcontainers.Xunit/IDbContainerTestMethods.cs
index 07a003a7f..a45e032c2 100644
--- a/src/Testcontainers.Xunit/IDbContainerTestMethods.cs
+++ b/src/Testcontainers.Xunit/IDbContainerTestMethods.cs
@@ -26,7 +26,7 @@ internal interface IDbContainerTestMethods
     /// <para />
     /// It is the responsibility of the caller to properly dispose the connection returned by this method. Failure to do so may result in a connection leak.
     /// </remarks>
-    /// <returns>A new, open connection to the database represented.</returns>
+    /// <returns>A new, open connection to the database.</returns>
     DbConnection OpenConnection();
 
     /// <summary>