Skip to content

Commit 5db7b46

Browse files
committed
Clean up SA1625 tests
1 parent 9c45401 commit 5db7b46

1 file changed

Lines changed: 24 additions & 109 deletions

File tree

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1625UnitTests.cs

Lines changed: 24 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -369,113 +369,18 @@ public void Test() {{ }}
369369
await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
370370
}
371371

372-
// [Fact]
373-
// public async Task VerifyThatAnalysisIgnoresEmptyElementsInIncludedDocumentationAsync()
374-
// {
375-
// var testCode = $@"
376-
//public class TestClass
377-
//{{
378-
// /// <summary></summary>
379-
// /// <remark>Documentation</remark>
380-
// /// <remark></remark>
381-
// /// <remark>Documentation</remark>
382-
// /// <include file='With.xml' path='/TestClass/Test/*' />
383-
// public void Test() {{ }}
384-
//}}
385-
//";
386-
// var expected = this.CSharpDiagnostic().WithLocation(7, 9);
387-
// await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
388-
// }
389-
390-
// [Fact]
391-
// public async Task VerifyThatCorrectIncludedDocumentationDoesNotReportADiagnosticMultiLineAsync()
392-
// {
393-
// var testCode = $@"
394-
//public class TestClass
395-
//{{
396-
// /** <summary>
397-
// * Some documentation.
398-
// * </summary>
399-
// * <remark>Some remark.</remark>
400-
// **/
401-
// public void Test() {{ }}
402-
//}}
403-
//";
404-
// await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
405-
// }
406-
407-
// [Fact]
408-
// public async Task VerifyThatIncludedDuplicatedDocumentationDoesReportADiagnosticMultiLineAsync()
409-
// {
410-
// var testCode = $@"
411-
//public class TestClass
412-
//{{
413-
// /** <summary>Some documentation.</summary>
414-
// * <remark>Some documentation.</remark>
415-
// **/
416-
// public void Test() {{ }}
417-
//}}
418-
//";
419-
// var expected = this.CSharpDiagnostic().WithLocation(5, 7);
420-
421-
// await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
422-
// }
423-
424-
// [Fact]
425-
// public async Task VerifyThatAnalyzerIgnoresIncludedLeadingAndTrailingWhitespaceMultiLineAsync()
426-
// {
427-
// var testCode = $@"
428-
//public class TestClass
429-
//{{
430-
// /** <summary>
431-
// * Some documentation.
432-
// *
433-
// *
434-
// * </summary>
435-
// * <remark> Some documentation. </remark>
436-
// **/
437-
// public void Test() {{ }}
438-
//}}
439-
//";
440-
// var expected = this.CSharpDiagnostic().WithLocation(9, 7);
441-
// await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
442-
// }
443-
444-
// [Fact]
445-
// public async Task VerifyThatAnalysisIgnoresIncludedUnusedParametersMultiLineAsync()
446-
// {
447-
// var testCode = $@"
448-
//public class TestClass
449-
//{{
450-
// /** <summary>The parameter is not used.</summary>
451-
// * <remark>Documentation</remark>
452-
// * <remark>The parameter is not used.</remark>
453-
// * <remark>Documentation</remark>
454-
// **/
455-
// public void Test() {{ }}
456-
//}}
457-
//";
458-
// var expected = this.CSharpDiagnostic().WithLocation(7, 7);
459-
// await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
460-
// }
461-
462-
// [Fact]
463-
// public async Task VerifyThatAnalysisIgnoresIncludedEmptyElementsMultiLineAsync()
464-
// {
465-
// var testCode = $@"
466-
//public class TestClass
467-
//{{
468-
// /** <summary></summary>
469-
// * <remark>Documentation</remark>
470-
// * <remark></remark>
471-
// * <remark>Documentation</remark>
472-
// **/
473-
// public void Test() {{ }}
474-
//}}
475-
//";
476-
// var expected = this.CSharpDiagnostic().WithLocation(7, 7);
477-
// await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
478-
// }
372+
[Fact]
373+
public async Task VerifyThatAnalysisIgnoresEmptyElementsInIncludedDocumentationAsync()
374+
{
375+
var testCode = $@"
376+
public class TestClass
377+
{{
378+
/// <include file='CorrectEmpty.xml' path='/TestClass/Test/*' />
379+
public void Test() {{ }}
380+
}}
381+
";
382+
await this.VerifyCSharpDiagnosticAsync(testCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
383+
}
479384

480385
/// <inheritdoc/>
481386
protected override Project ApplyCompilationOptions(Project project)
@@ -494,7 +399,7 @@ Some documentation.
494399
";
495400
resolver.XmlReferences.Add("Correct.xml", correctDocumentation);
496401

497-
string correctWithEmptyElements = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
402+
string correctWithEmptyReferenceElements = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
498403
<TestClass>
499404
<Test>
500405
<summary>
@@ -507,7 +412,17 @@ Some documentation.
507412
</Test>
508413
</TestClass>
509414
";
510-
resolver.XmlReferences.Add("CorrectWithEmptyElements.xml", correctWithEmptyElements);
415+
resolver.XmlReferences.Add("CorrectWithEmptyElements.xml", correctWithEmptyReferenceElements);
416+
417+
string correctWithEmptyElements = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
418+
<TestClass>
419+
<Test>
420+
<summary></summary>
421+
<remark></remark>
422+
</Test>
423+
</TestClass>
424+
";
425+
resolver.XmlReferences.Add("CorrectEmpty.xml", correctWithEmptyElements);
511426

512427
string inherited = @"<?xml version=""1.0"" encoding=""utf-8"" ?>
513428
<TestClass>

0 commit comments

Comments
 (0)