Skip to content

Commit 63a935b

Browse files
committed
Include XML documentation
1 parent 1d8126f commit 63a935b

File tree

4 files changed

+40
-2
lines changed

4 files changed

+40
-2
lines changed

Xunit.Priority/DefaultPriorityAttribute.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@
2222

2323
namespace Xunit.Priority
2424
{
25+
/// <summary>
26+
/// Indicates the priority value which will be assigned
27+
/// to tests in this class which don't have a <see cref="PriorityAttribute"/>.
28+
/// </summary>
2529
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
2630
public class DefaultPriorityAttribute: Attribute
2731
{

Xunit.Priority/PriorityAttribute.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,12 @@
1919
namespace Xunit.Priority
2020
{
2121
/// <summary>
22-
/// Indicates relative priority of tests for execution. Tests with the same
23-
/// priority are run in alphabetical order. Tests with no priority are run last.
22+
/// <para>Indicates relative priority of tests for execution. Tests with the same
23+
/// priority are run in alphabetical order. </para>
24+
///
25+
/// <para>Tests with no priority attribute
26+
/// are assigned a priority of <see cref="int.MaxValue"/>,
27+
/// unless the class has a <see cref="DefaultPriorityAttribute"/>.</para>
2428
/// </summary>
2529
[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
2630
public class PriorityAttribute : Attribute

Xunit.Priority/Xunit.Priority.csproj

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@
1616
<RepositoryType>git</RepositoryType>
1717
<PackageIconUrl>https://raw.githubusercontent.com/asherber/Xunit.Priority/master/media/xunit-priority-64.png</PackageIconUrl>
1818
</PropertyGroup>
19+
20+
<PropertyGroup>
21+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
22+
<DocumentationFile>$(AssemblyName).xml</DocumentationFile>
23+
<NoWarn>$(NoWarn);1591;1570;1587</NoWarn>
24+
</PropertyGroup>
1925

2026
<ItemGroup>
2127
<PackageReference Include="xunit.extensibility.core" Version="2.3.1" />

Xunit.Priority/Xunit.Priority.xml

Lines changed: 24 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)