Skip to content

Commit ef3b269

Browse files
committed
Improve the XML documentation
1 parent 7717214 commit ef3b269

3 files changed

Lines changed: 4 additions & 1 deletion

File tree

src/Testcontainers.Xunit/ContainerFixture.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ namespace Testcontainers.Xunit;
55
/// See <a href="https://xunit.net/docs/shared-context">Shared Context between Tests</a> from xUnit.net documentation for more information about fixtures.
66
/// A logger is automatically configured to write diagnostic messages to xUnit's <see cref="IMessageSink" />.
77
/// </summary>
8+
/// <param name="messageSink">An optional <see cref="IMessageSink"/> where the logs are written to. Pass <c>null</c> to ignore logs.</param>
89
/// <typeparam name="TBuilderEntity">The builder entity.</typeparam>
910
/// <typeparam name="TContainerEntity">The container entity.</typeparam>
1011
[PublicAPI]

src/Testcontainers.Xunit/ContainerTest.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ namespace Testcontainers.Xunit;
44
/// Base class for tests needing a container per test method.
55
/// A logger is automatically configured to write messages to xUnit's <see cref="ITestOutputHelper" />.
66
/// </summary>
7+
/// <param name="testOutputHelper">An optional <see cref="ITestOutputHelper"/> where the logs are written to. Pass <c>null</c> to ignore logs.</param>
8+
/// <param name="configure">An optional callback to configure the container.</param>
79
/// <typeparam name="TBuilderEntity">The builder entity.</typeparam>
810
/// <typeparam name="TContainerEntity">The container entity.</typeparam>
911
[PublicAPI]

src/Testcontainers.Xunit/IDbContainerTestMethods.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ internal interface IDbContainerTestMethods
2626
/// <para />
2727
/// 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.
2828
/// </remarks>
29-
/// <returns>A new, open connection to the database represented.</returns>
29+
/// <returns>A new, open connection to the database.</returns>
3030
DbConnection OpenConnection();
3131

3232
/// <summary>

0 commit comments

Comments
 (0)