Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6a829ec

Browse files
bradwilsonbradwilson
committed
Some missed <c> to <see> transformations
1 parent d791eb3 commit 6a829ec

7 files changed

Lines changed: 27 additions & 28 deletions

File tree

‎src/xunit.v3.core/Abstractions/Attributes/IDataAttribute.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,25 +46,25 @@ public interface IDataAttribute
4646
Type? SkipType { get; }
4747

4848
/// <summary>
49-
/// Gets the name of a public static property on the test class which returns <c>bool</c>
49+
/// Gets the name of a public static property on the test class which returns <see cref="bool"/>
5050
/// to indicate whether the test should be skipped (<see langword="false"/>) or not (<see langword="true"/>).
5151
/// </summary>
5252
/// <remarks>
5353
/// This property cannot be set if <see cref="SkipWhen"/> is set. Setting both will
5454
/// result in a failed test.
55-
/// To ensure compile-time safety and easier refactoring, use the <c>nameof</c> operator,
55+
/// To ensure compile-time safety and easier refactoring, use the <see langword="nameof"/> operator,
5656
/// e.g., <c>SkipUnless = nameof(IsConditionMet)</c>.
5757
/// </remarks>
5858
string? SkipUnless { get; }
5959

6060
/// <summary>
61-
/// Gets the name of a public static property on the test class which returns <c>bool</c>
61+
/// Gets the name of a public static property on the test class which returns <see cref="bool"/>
6262
/// to indicate whether the test should be skipped (<see langword="true"/>) or not (<see langword="false"/>).
6363
/// </summary>
6464
/// <remarks>
6565
/// This property cannot be set if <see cref="SkipUnless"/> is set. Setting both will
6666
/// result in a failed test.
67-
/// To ensure compile-time safety and easier refactoring, use the <c>nameof</c> operator
67+
/// To ensure compile-time safety and easier refactoring, use the <see langword="nameof"/> operator
6868
/// e.g., <c>SkipWhen = nameof(IsConditionMet)</c>.
6969
/// </remarks>
7070
string? SkipWhen { get; }

‎src/xunit.v3.core/Abstractions/Attributes/IFactAttribute.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public interface IFactAttribute
5757
/// This property cannot be set if <see cref="SkipWhen"/> is set. Setting both will
5858
/// result in a failed test.<br />
5959
/// <br />
60-
/// To ensure compile-time safety and easier refactoring, use the <c>nameof</c> operator,
60+
/// To ensure compile-time safety and easier refactoring, use the <see langword="nameof"/> operator,
6161
/// e.g., <c>SkipUnless = nameof(IsConditionMet)</c>.
6262
/// </remarks>
6363
string? SkipUnless { get; }
@@ -70,7 +70,7 @@ public interface IFactAttribute
7070
/// This property cannot be set if <see cref="SkipUnless"/> is set. Setting both will
7171
/// result in a failed test.<br />
7272
/// <br />
73-
/// To ensure compile-time safety and easier refactoring, use the <c>nameof</c> operator,
73+
/// To ensure compile-time safety and easier refactoring, use the <see langword="nameof"/> operator,
7474
/// e.g., <c>SkipWhen = nameof(IsConditionMet)</c>.
7575
/// </remarks>
7676
string? SkipWhen { get; }

‎src/xunit.v3.core/Attributes/DataAttribute.cs‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,15 +98,14 @@ public int Timeout
9898

9999
/// <summary>
100100
/// Converts an item yielded by the data attribute to an <see cref="ITheoryDataRow"/>, for return
101-
/// from <see cref="GetData"/>. Items yielded will typically be <c>object[]</c>, <see cref="ITheoryDataRow"/>,
101+
/// from <see cref="GetData"/>. Items yielded will typically be <see cref="object"/>[], <see cref="ITheoryDataRow"/>,
102102
/// or <see cref="T:System.Runtime.CompilerServices.ITuple"/>, but this override will allow derived
103103
/// attribute types to support additional data items. If the data item cannot be converted, this method
104104
/// will throw <see cref="ArgumentException"/>.
105105
/// </summary>
106106
/// <param name="dataRow">An item yielded from the data member.</param>
107107
/// <returns>An <see cref="ITheoryDataRow"/> suitable for return from <see cref="GetData"/>.</returns>
108-
/// <exception cref="ArgumentException">Thrown when <paramref name="dataRow"/> does not point to a valid data
109-
/// row (must be compatible with <c>object[]</c> or <see cref="ITheoryDataRow"/>).</exception>
108+
/// <exception cref="ArgumentException">Thrown when <paramref name="dataRow"/> does not point to a valid data row.</exception>
110109
protected virtual ITheoryDataRow ConvertDataRow(object dataRow)
111110
{
112111
Guard.ArgumentNotNull(dataRow);

‎src/xunit.v3.core/Attributes/MemberDataAttributeBase.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ namespace Xunit.v3;
1313
/// <summary>
1414
/// Provides a base class for attributes that will provide member data.
1515
/// </summary>
16-
/// <param name="memberName">
17-
/// The name of the public static member on the test class that will provide the test data
18-
/// It is recommended to use the <c>nameof</c> operator to ensure compile-time safety, e.g., <c>nameof(SomeMemberName)</c>.
19-
/// </param>
20-
/// <param name="arguments">The arguments to be passed to the member (only supported for methods; ignored for everything else)</param>
16+
/// <param name="memberName">The name of the public static member on the test class that will provide the test data.
17+
/// It is recommended to use the <see langword="nameof"/> operator to ensure compile-time safety, e.g.,
18+
/// <c>nameof(SomeMemberName)</c>.</param>
19+
/// <param name="arguments">The arguments to be passed to the member (only supported for methods; ignored for
20+
/// everything else)</param>
2121
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
2222
public abstract class MemberDataAttributeBase(
2323
string memberName,

‎src/xunit.v3.core/ITheoryDataRow.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public interface ITheoryDataRow
5151
/// This property cannot be set if <see cref="SkipWhen"/> is set. Setting both will
5252
/// result in a failed test.<br />
5353
/// <br />
54-
/// To ensure compile-time safety and easier refactoring, use the <c>nameof</c> operator,
54+
/// To ensure compile-time safety and easier refactoring, use the <see langword="nameof"/> operator,
5555
/// e.g., <c>SkipUnless = nameof(IsConditionMet)</c>.
5656
/// </remarks>
5757
string? SkipUnless { get; }
@@ -64,7 +64,7 @@ public interface ITheoryDataRow
6464
/// This property cannot be set if <see cref="SkipUnless"/> is set. Setting both will
6565
/// result in a failed test.<br />
6666
/// <br />
67-
/// To ensure compile-time safety and easier refactoring, use the <c>nameof</c> operator,
67+
/// To ensure compile-time safety and easier refactoring, use the <see langword="nameof"/> operator,
6868
/// e.g., <c>SkipWhen = nameof(IsConditionMet)</c>.
6969
/// </remarks>
7070
string? SkipWhen { get; }

‎src/xunit.v3.core/MemberDataAttribute.cs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ namespace Xunit;
1212
/// 3. A public static method (with parameters)
1313
/// </summary>
1414
/// <remarks>
15-
/// The member must return data in a form that is compatible, which means collections of <c>object?[]</c>,
16-
/// <c>ITheoryDataRow</c>, or tuple values. Those collections may come via <see cref="IEnumerable{T}"/> or
15+
/// The member must return data in a form that is compatible, which means collections of <see cref="object"/>?[],
16+
/// <see cref="ITheoryDataRow"/>, or tuple values. Those collections may come via <see cref="IEnumerable{T}"/> or
1717
/// <see cref="IAsyncEnumerable{T}"/>, and those collections may optionally be wrapped in either
1818
/// <see cref="Task{TResult}"/> or <see cref="ValueTask{TResult}"/>.
1919
/// </remarks>
20-
/// <param name="memberName">
21-
/// The name of the public static member on the test class that will provide the test data
22-
/// It is recommended to use the <c>nameof</c> operator to ensure compile-time safety, e.g., <c>nameof(SomeMemberName)</c>.
23-
/// </param>
24-
/// <param name="arguments">The arguments to be passed to the member (only supported for methods; ignored for everything else)</param>
20+
/// <param name="memberName">The name of the public static member on the test class that will provide the test data.
21+
/// It is recommended to use the <see langword="nameof"/> operator to ensure compile-time safety, e.g.,
22+
/// <c>nameof(SomeMemberName)</c>.</param>
23+
/// <param name="arguments">The arguments to be passed to the member (only supported for methods; ignored for
24+
/// everything else)</param>
2525
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
2626
public sealed class MemberDataAttribute(
2727
string memberName,

‎src/xunit.v3.runner.utility/Frameworks/v3/Xunit3ArgumentFactory.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public static class Xunit3ArgumentFactory
1717
static readonly Version Version_0_3_0 = new(0, 3, 0);
1818

1919
/// <summary>
20-
/// Gets command line switches based on a call to <c>Find</c> on <see cref="Xunit3"/>.
20+
/// Gets command line switches based on a call to <see cref="Xunit3.Find"/>.
2121
/// </summary>
2222
public static List<string> ForFind(
2323
Version coreFrameworkVersion,
@@ -62,7 +62,7 @@ public static List<string> ForFind(
6262
}
6363

6464
/// <summary>
65-
/// Gets command line switches based on a call to <c>FindAndRun</c> <see cref="Xunit3"/>.
65+
/// Gets command line switches based on a call to <see cref="Xunit3.FindAndRun"/>.
6666
/// </summary>
6767
public static List<string> ForFindAndRun(
6868
Version coreFrameworkVersion,
@@ -108,7 +108,7 @@ public static List<string> ForFindAndRun(
108108
}
109109

110110
/// <summary>
111-
/// Gets command line switches based on a call to <c>Find</c> on <see cref="TestProcessLauncherAdapter"/>.
111+
/// Gets command line switches based on a call to <see cref="TestProcessLauncherAdapter.Find(XunitProjectAssembly, TestAssemblyInfo, IMessageSink, IMessageSink?, ISourceInformationProvider?)"/>.
112112
/// </summary>
113113
public static List<string> ForFindInProcess(
114114
Version coreFrameworkVersion,
@@ -137,7 +137,7 @@ public static List<string> ForRun(
137137
ForRun(coreFrameworkVersion, options, serializedTestCases, [], configFileName, waitForDebugger);
138138

139139
/// <summary>
140-
/// Gets command line switches based on a call to <c>Run</c> on <see cref="Xunit3"/>.
140+
/// Gets command line switches based on a call to <see cref="Xunit3.Run"/>.
141141
/// </summary>
142142
public static List<string> ForRun(
143143
Version coreFrameworkVersion,
@@ -340,7 +340,7 @@ static List<string> ToArguments(
340340
}
341341

342342
/// <summary>
343-
/// Gets command line switches based on a call to <c>Run</c> on <see cref="TestProcessLauncherAdapter"/>.
343+
/// Gets command line switches based on a call to <see cref="TestProcessLauncherAdapter.Run(XunitProjectAssembly, TestAssemblyInfo, IMessageSink, IMessageSink?, ISourceInformationProvider?)"/>.
344344
/// </summary>
345345
public static List<string> ForRunInProcess(
346346
Version coreFrameworkVersion,

0 commit comments

Comments
 (0)