Skip to content

Commit 1c94143

Browse files
ForNeVeRForNeVeR
authored
XML docs: param → paramref where appropriate (#930)
1 parent 810faa1 commit 1c94143

File tree

12 files changed

+36
-36
lines changed

12 files changed

+36
-36
lines changed

‎src/Verify.Expecto/Verifier_Directory.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ public static partial class Verifier
77
#if NETSTANDARD2_1 || NETCOREAPP3_0_OR_GREATER || NET5_0_OR_GREATER
88

99
/// <summary>
10-
/// Verifies the contents of <param name="path"/>.
10+
/// Verifies the contents of <paramref name="path"/>.
1111
/// </summary>
1212
public static Task<VerifyResult> VerifyDirectory(
1313
string name,
@@ -25,7 +25,7 @@ public static Task<VerifyResult> VerifyDirectory(
2525
}
2626

2727
/// <summary>
28-
/// Verifies the contents of <param name="path"/>.
28+
/// Verifies the contents of <paramref name="path"/>.
2929
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object target)</code> which will verify the full path.
3030
/// </summary>
3131
public static Task<VerifyResult> VerifyDirectory(
@@ -43,7 +43,7 @@ public static Task<VerifyResult> VerifyDirectory(
4343
#else
4444

4545
/// <summary>
46-
/// Verifies the contents of <param name="path"/>.
46+
/// Verifies the contents of <paramref name="path"/>.
4747
/// </summary>
4848
public static Task<VerifyResult> VerifyDirectory(
4949
string name,
@@ -61,7 +61,7 @@ public static Task<VerifyResult> VerifyDirectory(
6161
}
6262

6363
/// <summary>
64-
/// Verifies the contents of <param name="path"/>.
64+
/// Verifies the contents of <paramref name="path"/>.
6565
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object target)</code> which will verify the full path.
6666
/// </summary>
6767
public static Task<VerifyResult> VerifyDirectory(

‎src/Verify.Expecto/Verifier_File.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ namespace VerifyExpecto;
55
public static partial class Verifier
66
{
77
/// <summary>
8-
/// Verifies the contents of <param name="path"/>.
8+
/// Verifies the contents of <paramref name="path"/>.
99
/// </summary>
1010
public static Task<VerifyResult> VerifyFile(
1111
string name,
@@ -19,7 +19,7 @@ public static Task<VerifyResult> VerifyFile(
1919
}
2020

2121
/// <summary>
22-
/// Verifies the contents of <param name="path"/>.
22+
/// Verifies the contents of <paramref name="path"/>.
2323
/// Differs from passing <see cref="FileInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
2424
/// </summary>
2525
public static Task<VerifyResult> VerifyFile(

‎src/Verify.MSTest/VerifyBase_Directory.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ public partial class VerifyBase
55
#if NETSTANDARD2_1 || NETCOREAPP3_0_OR_GREATER || NET5_0_OR_GREATER
66

77
/// <summary>
8-
/// Verifies the contents of <param name="path"/>.
8+
/// Verifies the contents of <paramref name="path"/>.
99
/// </summary>
1010
public SettingsTask VerifyDirectory(
1111
string path,
@@ -19,7 +19,7 @@ public SettingsTask VerifyDirectory(
1919
Verify(settings, sourceFile, _ => _.VerifyDirectory(path, include, pattern, options, info, fileScrubber), true);
2020

2121
/// <summary>
22-
/// Verifies the contents of <param name="path"/>.
22+
/// Verifies the contents of <paramref name="path"/>.
2323
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
2424
/// </summary>
2525
public SettingsTask VerifyDirectory(
@@ -35,7 +35,7 @@ public SettingsTask VerifyDirectory(
3535
#else
3636

3737
/// <summary>
38-
/// Verifies the contents of <param name="path"/>.
38+
/// Verifies the contents of <paramref name="path"/>.
3939
/// </summary>
4040
public SettingsTask VerifyDirectory(
4141
string path,
@@ -49,7 +49,7 @@ public SettingsTask VerifyDirectory(
4949
Verify(settings, sourceFile, _ => _.VerifyDirectory(path, include, pattern, option, info, fileScrubber), true);
5050

5151
/// <summary>
52-
/// Verifies the contents of <param name="path"/>.
52+
/// Verifies the contents of <paramref name="path"/>.
5353
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
5454
/// </summary>
5555
public SettingsTask VerifyDirectory(

‎src/Verify.MSTest/VerifyBase_File.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
public partial class VerifyBase
44
{
55
/// <summary>
6-
/// Verifies the contents of <param name="path"/>.
6+
/// Verifies the contents of <paramref name="path"/>.
77
/// </summary>
88
public SettingsTask VerifyFile(
99
string path,
@@ -13,7 +13,7 @@ public SettingsTask VerifyFile(
1313
Verify(settings, sourceFile, _ => _.VerifyFile(path, info));
1414

1515
/// <summary>
16-
/// Verifies the contents of <param name="path"/>.
16+
/// Verifies the contents of <paramref name="path"/>.
1717
/// Differs from passing <see cref="FileInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
1818
/// </summary>
1919
public SettingsTask VerifyFile(

‎src/Verify.NUnit/Verifier_Directory.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ public static partial class Verifier
55
#if NETSTANDARD2_1 || NETCOREAPP3_0_OR_GREATER || NET5_0_OR_GREATER
66

77
/// <summary>
8-
/// Verifies the contents of <param name="path"/>.
8+
/// Verifies the contents of <paramref name="path"/>.
99
/// </summary>
1010
public static SettingsTask VerifyDirectory(
1111
string path,
@@ -19,7 +19,7 @@ public static SettingsTask VerifyDirectory(
1919
Verify(settings, sourceFile, _ => _.VerifyDirectory(path, include, pattern, options, info, fileScrubber), true);
2020

2121
/// <summary>
22-
/// Verifies the contents of <param name="path"/>.
22+
/// Verifies the contents of <paramref name="path"/>.
2323
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
2424
/// </summary>
2525
public static SettingsTask VerifyDirectory(
@@ -36,7 +36,7 @@ public static SettingsTask VerifyDirectory(
3636
#else
3737

3838
/// <summary>
39-
/// Verifies the contents of <param name="path"/>.
39+
/// Verifies the contents of <paramref name="path"/>.
4040
/// </summary>
4141
public static SettingsTask VerifyDirectory(
4242
string path,
@@ -54,7 +54,7 @@ public static SettingsTask VerifyDirectory(
5454
true);
5555

5656
/// <summary>
57-
/// Verifies the contents of <param name="path"/>.
57+
/// Verifies the contents of <paramref name="path"/>.
5858
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
5959
/// </summary>
6060
public static SettingsTask VerifyDirectory(

‎src/Verify.NUnit/Verifier_File.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
public static partial class Verifier
44
{
55
/// <summary>
6-
/// Verifies the contents of <param name="path"/>.
6+
/// Verifies the contents of <paramref name="path"/>.
77
/// </summary>
88
public static SettingsTask VerifyFile(
99
string path,
@@ -13,7 +13,7 @@ public static SettingsTask VerifyFile(
1313
Verify(settings, sourceFile, _ => _.VerifyFile(path, info));
1414

1515
/// <summary>
16-
/// Verifies the contents of <param name="path"/>.
16+
/// Verifies the contents of <paramref name="path"/>.
1717
/// Differs from passing <see cref="FileInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
1818
/// </summary>
1919
public static SettingsTask VerifyFile(

‎src/Verify.NUnit/VerifyBase_Directory.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ public partial class VerifyBase
55
#if NETSTANDARD2_1 || NETCOREAPP3_0_OR_GREATER || NET5_0_OR_GREATER
66

77
/// <summary>
8-
/// Verifies the contents of <param name="path"/>.
8+
/// Verifies the contents of <paramref name="path"/>.
99
/// </summary>
1010
public SettingsTask VerifyDirectory(
1111
string path,
@@ -26,7 +26,7 @@ public SettingsTask VerifyDirectory(
2626
sourceFile);
2727

2828
/// <summary>
29-
/// Verifies the contents of <param name="path"/>.
29+
/// Verifies the contents of <paramref name="path"/>.
3030
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
3131
/// </summary>
3232
public SettingsTask VerifyDirectory(
@@ -50,7 +50,7 @@ public SettingsTask VerifyDirectory(
5050
#else
5151

5252
/// <summary>
53-
/// Verifies the contents of <param name="path"/>.
53+
/// Verifies the contents of <paramref name="path"/>.
5454
/// </summary>
5555
public SettingsTask VerifyDirectory(
5656
string path,
@@ -71,7 +71,7 @@ public SettingsTask VerifyDirectory(
7171
sourceFile);
7272

7373
/// <summary>
74-
/// Verifies the contents of <param name="path"/>.
74+
/// Verifies the contents of <paramref name="path"/>.
7575
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
7676
/// </summary>
7777
public SettingsTask VerifyDirectory(

‎src/Verify.NUnit/VerifyBase_File.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
public partial class VerifyBase
44
{
55
/// <summary>
6-
/// Verifies the contents of <param name="path"/>.
6+
/// Verifies the contents of <paramref name="path"/>.
77
/// </summary>
88
public SettingsTask VerifyFile(
99
string path,
@@ -12,7 +12,7 @@ public SettingsTask VerifyFile(
1212
Verifier.VerifyFile(path, settings ?? this.settings, info, sourceFile);
1313

1414
/// <summary>
15-
/// Verifies the contents of <param name="path"/>.
15+
/// Verifies the contents of <paramref name="path"/>.
1616
/// Differs from passing <see cref="FileInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
1717
/// </summary>
1818
public SettingsTask VerifyFile(

‎src/Verify.Xunit/Verifier_Directory.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ public static partial class Verifier
55
#if NETSTANDARD2_1 || NETCOREAPP3_0_OR_GREATER || NET5_0_OR_GREATER
66

77
/// <summary>
8-
/// Verifies the contents of <param name="path"/>.
8+
/// Verifies the contents of <paramref name="path"/>.
99
/// </summary>
1010
public static SettingsTask VerifyDirectory(
1111
string path,
@@ -19,7 +19,7 @@ public static SettingsTask VerifyDirectory(
1919
Verify(settings, sourceFile, _ => _.VerifyDirectory(path, include, pattern, options, info, fileScrubber), true);
2020

2121
/// <summary>
22-
/// Verifies the contents of <param name="path"/>.
22+
/// Verifies the contents of <paramref name="path"/>.
2323
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
2424
/// </summary>
2525
public static SettingsTask VerifyDirectory(
@@ -36,7 +36,7 @@ public static SettingsTask VerifyDirectory(
3636
#else
3737

3838
/// <summary>
39-
/// Verifies the contents of <param name="path"/>.
39+
/// Verifies the contents of <paramref name="path"/>.
4040
/// </summary>
4141
public static SettingsTask VerifyDirectory(
4242
string path,
@@ -54,7 +54,7 @@ public static SettingsTask VerifyDirectory(
5454
true);
5555

5656
/// <summary>
57-
/// Verifies the contents of <param name="path"/>.
57+
/// Verifies the contents of <paramref name="path"/>.
5858
/// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
5959
/// </summary>
6060
public static SettingsTask VerifyDirectory(

‎src/Verify.Xunit/Verifier_File.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
public static partial class Verifier
44
{
55
/// <summary>
6-
/// Verifies the contents of <param name="path"/>.
6+
/// Verifies the contents of <paramref name="path"/>.
77
/// </summary>
88
public static SettingsTask VerifyFile(
99
string path,
@@ -13,7 +13,7 @@ public static SettingsTask VerifyFile(
1313
Verify(settings, sourceFile, _ => _.VerifyFile(path, info));
1414

1515
/// <summary>
16-
/// Verifies the contents of <param name="path"/>.
16+
/// Verifies the contents of <paramref name="path"/>.
1717
/// Differs from passing <see cref="FileInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
1818
/// </summary>
1919
public static SettingsTask VerifyFile(

0 commit comments

Comments
 (0)