Skip to content

Commit

Permalink
Consolidate documentation of exception typeparam
Browse files Browse the repository at this point in the history
  • Loading branch information
lg2de committed Dec 7, 2022
1 parent 3d41dcc commit 3f6c983
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Src/FluentAssertions/Specialized/AsyncFunctionAssertions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,7 @@ public AsyncFunctionAssertions(Func<TTask> subject, IExtractExceptions extractor
/// <summary>
/// Asserts that the current <see cref="Func{Task}"/> throws an exception of the exact type <typeparamref name="TException"/> (and not a derived exception type).
/// </summary>
/// <typeparam name="TException">
/// The type of the exception it should throw.
/// </typeparam>
/// <typeparam name="TException">The type of exception expected to be thrown.</typeparam>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
Expand Down Expand Up @@ -147,6 +145,7 @@ public AsyncFunctionAssertions(Func<TTask> subject, IExtractExceptions extractor
/// <summary>
/// Asserts that the current <see cref="Func{Task}"/> throws an exception of type <typeparamref name="TException"/>.
/// </summary>
/// <typeparam name="TException">The type of exception expected to be thrown.</typeparam>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
Expand All @@ -170,6 +169,7 @@ public AsyncFunctionAssertions(Func<TTask> subject, IExtractExceptions extractor
/// <summary>
/// Asserts that the current <see cref="Func{Task}"/> throws an exception of type <typeparamref name="TException"/>.
/// </summary>
/// <typeparam name="TException">The type of exception expected to be thrown.</typeparam>
/// <param name="timeSpan">The allowed time span for the operation.</param>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
Expand Down Expand Up @@ -224,6 +224,7 @@ public async Task<AndConstraint<TAssertions>> NotThrowAsync(string because = "",
/// <summary>
/// Asserts that the current <see cref="Func{Task}"/> does not throw an exception of type <typeparamref name="TException"/>.
/// </summary>
/// <typeparam name="TException">The type of exception expected to not be thrown.</typeparam>
/// <param name="because">
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
Expand Down

0 comments on commit 3f6c983

Please sign in to comment.