Skip to content

Commit

Permalink
Improve the XML documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
0xced committed Nov 25, 2024
1 parent 7717214 commit ef3b269
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
1 change: 1 addition & 0 deletions src/Testcontainers.Xunit/ContainerFixture.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 2 additions & 0 deletions src/Testcontainers.Xunit/ContainerTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion src/Testcontainers.Xunit/IDbContainerTestMethods.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit ef3b269

Please sign in to comment.