Skip to content

Commit 161bf74

Browse files
elachlansharwell
andauthored
SA1626 single-line comment which begins with three forward slashes in… (#7197)
Relates to #7174 https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1626.md Co-authored-by: Sam Harwell <sam@tunnelvisionlabs.com>
1 parent 3c8fb11 commit 161bf74

File tree

14 files changed

+24
-22
lines changed

14 files changed

+24
-22
lines changed

src/Build.OM.UnitTests/Construction/ProjectExtensionsElement_Tests.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@
1414
namespace Microsoft.Build.UnitTests.OM.Construction
1515
{
1616
/// <summary>
17-
// <summary>Tests for the ProjectExtensionsElement class.</summary>
18-
/// Tests for the class
17+
/// Tests for the <see cref="ProjectExtensionsElement"/> class.
1918
/// </summary>
2019
public class ProjectExtensionsElement_Tests
2120
{

src/Build.OM.UnitTests/ObjectModelRemoting/LinkedEvaluationModify_Tests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ public void ProjectItemModify()
122122
new KeyValuePair<string, string>("b", "bValue"),
123123
};
124124

125-
/// test AddItems
125+
// test AddItems
126126
// add a new files in the view, ensure it is added correctly and also the real object will immediately reflect that add as well
127127
Assert.Null(pair.GetSingleItemWithVerify(ObjectType.View, "foo.cpp"));
128128
var fooView = pair.AddSingleItemWithVerify(ObjectType.View, "cpp", "foo.cpp");

src/Build.OM.UnitTests/ObjectModelRemoting/RemoteProjectsProviderMock/EvaluationLinkMocks/MockProjectItemDefinitionLink.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ public override ProjectItemDefinition CreateLinkedObject(IImportHolder holder)
1717
return holder.Linker.LinkFactory.Create(link);
1818
}
1919

20-
21-
/// ProjectItemDefinitionLink remoting
20+
// ProjectItemDefinitionLink remoting
2221
public MockProjectLinkRemoter Project => this.OwningCollection.Export<Project, MockProjectLinkRemoter>(this.Source.Project);
2322
public string ItemType => this.Source.ItemType;
2423
public ICollection<MockProjectMetadataLinkRemoter> Metadata => this.OwningCollection.ExportCollection<ProjectMetadata, MockProjectMetadataLinkRemoter>(this.Source.Metadata);

src/Build.OM.UnitTests/ObjectModelRemoting/RemoteProjectsProviderMock/EvaluationLinkMocks/MockProjectItemLink.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ public override ProjectItem CreateLinkedObject(IImportHolder holder)
1818
return holder.Linker.LinkFactory.Create(link);
1919
}
2020

21-
22-
/// ProjectItemLink remoting
21+
// ProjectItemLink remoting
2322
public MockProjectLinkRemoter Project => this.OwningCollection.Export<Project, MockProjectLinkRemoter>(this.Source.Project);
2423
public MockProjectItemElementLinkRemoter Xml => (MockProjectItemElementLinkRemoter)this.OwningCollection.ExportElement(this.Source.Xml);
2524
public string EvaluatedInclude => this.Source.EvaluatedInclude;

src/Build.OM.UnitTests/ObjectModelRemoting/RemoteProjectsProviderMock/EvaluationLinkMocks/MockProjectLink.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ public override Project CreateLinkedObject(IImportHolder holder)
2424
return holder.Linker.LinkFactory.Create(link);
2525
}
2626

27-
28-
/// ProjectLink remoting
27+
// ProjectLink remoting
2928
public MockProjectElementLinkRemoter Xml => this.OwningCollection.ExportElement(this.Source.Xml);
3029

3130
public bool ThrowInsteadOfSplittingItemElement { get => this.Source.ThrowInsteadOfSplittingItemElement; set => this.Source.ThrowInsteadOfSplittingItemElement = value; }

src/Build.OM.UnitTests/ObjectModelRemoting/RemoteProjectsProviderMock/EvaluationLinkMocks/MockProjectMetadataLink.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ public override ProjectMetadata CreateLinkedObject(IImportHolder holder)
1717
return holder.Linker.LinkFactory.Create(link);
1818
}
1919

20-
21-
/// ProjectMetadataLink remoting
20+
// ProjectMetadataLink remoting
2221
public object Parent
2322
{
2423
get

src/Build.OM.UnitTests/ObjectModelRemoting/RemoteProjectsProviderMock/EvaluationLinkMocks/MockProjectPropertyLink.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ public override ProjectProperty CreateLinkedObject(IImportHolder holder)
1717
return holder.Linker.LinkFactory.Create(link);
1818
}
1919

20-
21-
/// ProjectPropertyLink remoting
20+
// ProjectPropertyLink remoting
2221
public MockProjectLinkRemoter Project => this.OwningCollection.Export<Project, MockProjectLinkRemoter>(this.Source.Project);
2322
public MockProjectPropertyElementLinkRemoter Xml => (MockProjectPropertyElementLinkRemoter)this.ExportElement(this.Source.Xml);
2423
public string Name => this.Source.Name;

src/Build.UnitTests/BackEnd/BuildManager_Tests.cs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3802,9 +3802,12 @@ public void OutOfProcFileBasedP2PBuildSucceeds()
38023802
}
38033803
}
38043804

3805-
/// When a ProjectInstance based BuildRequestData is built out of proc, the node should
3805+
/// <summary>
3806+
/// When a <see cref="ProjectInstance"/> based <see cref="BuildRequestData"/> is built out of proc, the node should
38063807
/// not reload it from disk but instead fully utilize the entire translate project instance state
3807-
/// to do the build
3808+
/// to do the build.
3809+
/// </summary>
3810+
/// <param name="shouldSerializeEntireState"><see langword="true"/> to serialize the entire project instance state; otherwise, <see langword="false"/>.</param>
38083811
[Theory]
38093812
[InlineData(false)]
38103813
[InlineData(true)]

src/Build/Construction/ProjectRootElement.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ namespace Microsoft.Build.Construction
4545
[DebuggerDisplay("{FullPath} #Children={Count} DefaultTargets={DefaultTargets} ToolsVersion={ToolsVersion} InitialTargets={InitialTargets} ExplicitlyLoaded={IsExplicitlyLoaded}")]
4646
public class ProjectRootElement : ProjectElementContainer
4747
{
48-
/// Constants for default (empty) project file.
48+
// Constants for default (empty) project file.
4949
private const string EmptyProjectFileContent = "{0}<Project{1}{2}>\r\n</Project>";
5050
private const string EmptyProjectFileXmlDeclaration = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n";
5151
private const string EmptyProjectFileToolsVersion = " ToolsVersion=\"" + MSBuildConstants.CurrentToolsVersion + "\"";

src/Build/Utilities/EngineFileUtilities.cs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,14 @@ private static bool MatchesLazyWildcard(string fileSpec)
227227
return _regexMatchCache.Value.GetOrAdd(fileSpec, file => s_lazyWildCardExpansionRegexes.Any(regex => regex.IsMatch(fileSpec)));
228228
}
229229

230-
/// Returns a Func that will return true IFF its argument matches any of the specified filespecs
231-
/// Assumes filespec may be escaped, so it unescapes it
230+
/// <summary>
231+
/// Returns a Func that will return true IFF its argument matches any of the specified filespecs.
232+
/// Assumes filespec may be escaped, so it unescapes it.
232233
/// The returned function makes no escaping assumptions or escaping operations. Its callers should control escaping.
234+
/// </summary>
235+
/// <param name="filespecsEscaped"></param>
236+
/// <param name="currentDirectory"></param>
237+
/// <returns>A Func that will return true IFF its argument matches any of the specified filespecs.</returns>
233238
internal static Func<string, bool> GetFileSpecMatchTester(IList<string> filespecsEscaped, string currentDirectory)
234239
{
235240
var matchers = filespecsEscaped

0 commit comments

Comments
 (0)