Skip to content

Commit eb30805

Browse files
committed
Fix reason and reasonArgs doc comments.
1 parent a323393 commit eb30805

26 files changed

+167
-133
lines changed

src/FluentAssertions.AspNetCore.Mvc/AcceptedAtActionResultAssertions.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public AcceptedAtActionResultAssertions(AcceptedAtActionResult subject) : base(s
2626
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
2727
/// </param>
2828
/// <param name="reasonArgs">
29-
/// Zero or more objects to format using the placeholders in <see cref="reason" />.
29+
/// Zero or more objects to format using the placeholders in <paramref name="reason"/>.
3030
/// </param>
3131
public AcceptedAtActionResultAssertions WithActionName(string expectedActionName, string reason = "", params object[] reasonArgs)
3232
{
@@ -46,11 +46,11 @@ public AcceptedAtActionResultAssertions WithActionName(string expectedActionName
4646
/// </summary>
4747
/// <param name="expectedControllerName">The expected controller.</param>
4848
/// <param name="reason">
49-
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
49+
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
5050
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
5151
/// </param>
5252
/// <param name="reasonArgs">
53-
/// Zero or more objects to format using the placeholders in <see cref="reason" />.
53+
/// Zero or more objects to format using the placeholders in <paramref name="reason"/>.
5454
/// </param>
5555
public AcceptedAtActionResultAssertions WithControllerName(string expectedControllerName, string reason = "", params object[] reasonArgs)
5656
{
@@ -71,11 +71,11 @@ public AcceptedAtActionResultAssertions WithControllerName(string expectedContro
7171
/// <param name="key">The expected key.</param>
7272
/// <param name="expectedValue">The expected value.</param>
7373
/// <param name="reason">
74-
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
74+
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
7575
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
7676
/// </param>
7777
/// <param name="reasonArgs">
78-
/// Zero or more objects to format using the placeholders in <see cref="reason" />.
78+
/// Zero or more objects to format using the placeholders in <paramref name="reason"/>.
7979
/// </param>
8080
public AcceptedAtActionResultAssertions WithRouteValue(string key, object expectedValue, string reason = "", params object[] reasonArgs)
8181
{

src/FluentAssertions.AspNetCore.Mvc/AcceptedAtRouteResultAssertions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public AcceptedAtRouteResultAssertions(AcceptedAtRouteResult subject) : base(sub
2626
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
2727
/// </param>
2828
/// <param name="reasonArgs">
29-
/// Zero or more objects to format using the placeholders in <see cref="reason" />.
29+
/// Zero or more objects to format using the placeholders in <paramref name="reason"/>.
3030
/// </param>
3131
public AcceptedAtRouteResultAssertions WithRouteName(string expectedRouteName, string reason = "", params object[] reasonArgs)
3232
{
@@ -51,7 +51,7 @@ public AcceptedAtRouteResultAssertions WithRouteName(string expectedRouteName, s
5151
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
5252
/// </param>
5353
/// <param name="reasonArgs">
54-
/// Zero or more objects to format using the placeholders in <see cref="reason" />.
54+
/// Zero or more objects to format using the placeholders in <paramref name="reason"/>.
5555
/// </param>
5656
public AcceptedAtRouteResultAssertions WithRouteValue(string key, object expectedValue, string reason = "", params object[] reasonArgs)
5757
{

src/FluentAssertions.AspNetCore.Mvc/AcceptedResultAssertions.cs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,13 @@ public TValue ValueAs<TValue>()
6868
/// <param name="uri">
6969
/// The Uri.
7070
/// </param>
71+
/// <param name="reason">
72+
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
73+
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
74+
/// </param>
75+
/// <param name="reasonArgs">
76+
/// Zero or more objects to format using the placeholders in <paramref name="reason"/>.
77+
/// </param>
7178
/// <returns>The typed value.</returns>
7279
public AcceptedResultAssertions WithUri(Uri uri, string reason = "", params object[] reasonArgs)
7380
{
@@ -90,6 +97,13 @@ public AcceptedResultAssertions WithUri(Uri uri, string reason = "", params obje
9097
/// <param name="uri">
9198
/// The Uri as string.
9299
/// </param>
100+
/// <param name="reason">
101+
/// A formatted phrase as is supported by <see cref="string.Format(string,object[])" /> explaining why the assertion
102+
/// is needed. If the phrase does not start with the word <i>because</i>, it is prepended automatically.
103+
/// </param>
104+
/// <param name="reasonArgs">
105+
/// Zero or more objects to format using the placeholders in <paramref name="reason"/>.
106+
/// </param>
93107
/// <returns>The typed value.</returns>
94108
public AcceptedResultAssertions WithUri(string uri, string reason = "", params object[] reasonArgs)
95109
{

0 commit comments

Comments
 (0)