Skip to content

Commit 3286aea

Browse files
committed
docs(docs-tests): author XML doc comments on test surface
1 parent 3b50d6b commit 3286aea

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

tests/MTConnect.NET-Docs-Tests/DocsReferenceGenerationTests.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ private static string RepoRoot
4646
}
4747
}
4848

49+
/// <summary>Pins the behaviour expressed by the test name: http api page is in sync with source.</summary>
4950
[Test]
5051
public void HttpApi_Page_Is_In_Sync_With_Source()
5152
{
@@ -63,6 +64,7 @@ public void HttpApi_Page_Is_In_Sync_With_Source()
6364
}
6465
}
6566

67+
/// <summary>Pins the behaviour expressed by the test name: environment variables page is in sync with source.</summary>
6668
[Test]
6769
public void EnvironmentVariables_Page_Is_In_Sync_With_Source()
6870
{
@@ -79,6 +81,7 @@ public void EnvironmentVariables_Page_Is_In_Sync_With_Source()
7981
}
8082
}
8183

84+
/// <summary>Pins the behaviour expressed by the test name: configuration page is in sync with source.</summary>
8285
[Test]
8386
public void Configuration_Page_Is_In_Sync_With_Source()
8487
{
@@ -96,6 +99,7 @@ public void Configuration_Page_Is_In_Sync_With_Source()
9699
}
97100
}
98101

102+
/// <summary>Pins the behaviour expressed by the test name: cli page is in sync with source.</summary>
99103
[Test]
100104
public void Cli_Page_Is_In_Sync_With_Source()
101105
{
@@ -120,6 +124,7 @@ public void Cli_Page_Is_In_Sync_With_Source()
120124
}
121125
}
122126

127+
/// <summary>Pins the behaviour expressed by the test name: endpoint code has no stale entries in markdown.</summary>
123128
[Test]
124129
public void Endpoint_Code_Has_No_Stale_Entries_In_Markdown()
125130
{
@@ -150,6 +155,7 @@ public void Endpoint_Code_Has_No_Stale_Entries_In_Markdown()
150155
}
151156
}
152157

158+
/// <summary>Pins the behaviour expressed by the test name: index page is in sync.</summary>
153159
[Test]
154160
public void Index_Page_Is_In_Sync()
155161
{

0 commit comments

Comments
 (0)