From 3d22f90367a5617938e630b74bb24455f1ec2d09 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Fri, 8 Sep 2017 20:30:22 +0200 Subject: [PATCH] Update comments --- .../MsBuildIssuesProviderTests.cs | 2 +- .../MsBuildIssuesSettingsTests.cs | 2 +- src/Cake.Issues.MsBuild/ILogFileFormat.cs | 6 ++--- .../MsBuildIssuesAliases.cs | 24 +++++++++---------- .../MsBuildIssuesProvider.cs | 2 +- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/Cake.Issues.MsBuild.Tests/MsBuildIssuesProviderTests.cs b/src/Cake.Issues.MsBuild.Tests/MsBuildIssuesProviderTests.cs index 0e08b9a..3d35d37 100644 --- a/src/Cake.Issues.MsBuild.Tests/MsBuildIssuesProviderTests.cs +++ b/src/Cake.Issues.MsBuild.Tests/MsBuildIssuesProviderTests.cs @@ -6,7 +6,7 @@ public class MsBuildIssuesProviderTests { - public sealed class TheMsBuildCodeAnalysisProviderCtor + public sealed class TheCtor { [Fact] public void Should_Throw_If_Log_Is_Null() diff --git a/src/Cake.Issues.MsBuild.Tests/MsBuildIssuesSettingsTests.cs b/src/Cake.Issues.MsBuild.Tests/MsBuildIssuesSettingsTests.cs index 1d70647..0667f4b 100644 --- a/src/Cake.Issues.MsBuild.Tests/MsBuildIssuesSettingsTests.cs +++ b/src/Cake.Issues.MsBuild.Tests/MsBuildIssuesSettingsTests.cs @@ -11,7 +11,7 @@ public class MsBuildIssuesSettingsTests { - public sealed class TheMsBuildCodeAnalysisSettingsCtor + public sealed class TheCtor { [Fact] public void Should_Throw_If_LogFilePath_Is_Null() diff --git a/src/Cake.Issues.MsBuild/ILogFileFormat.cs b/src/Cake.Issues.MsBuild/ILogFileFormat.cs index 95c1200..f2d9141 100644 --- a/src/Cake.Issues.MsBuild/ILogFileFormat.cs +++ b/src/Cake.Issues.MsBuild/ILogFileFormat.cs @@ -8,11 +8,11 @@ public interface ILogFileFormat { /// - /// Gets all code analysis issues. + /// Gets all issues. /// /// Repository settings to use. - /// Settings for code analysis provider to use. - /// List of code analysis issues + /// Settings for issue provider to use. + /// List of issues IEnumerable ReadIssues( RepositorySettings repositorySettings, MsBuildIssuesSettings msBuildIssuesSettings); diff --git a/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.cs b/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.cs index 92b751a..a5f61de 100644 --- a/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.cs +++ b/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.cs @@ -130,15 +130,15 @@ public static class MsBuildIssuesAliases } /// - /// Gets an instance of a provider for code analysis issues reported as MsBuild warnings using a log file from disk. + /// Gets an instance of a provider for issues reported as MsBuild warnings using a log file from disk. /// /// The context. /// Path to the the MsBuild log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided MsBuild log file. - /// Instance of a provider for code analysis issues reported as MsBuild warnings. + /// Instance of a provider for issues reported as MsBuild warnings. /// - /// Read code analysis issues reported as MsBuild warnings: + /// Read issues reported as MsBuild warnings: /// /// /// /// @@ -165,15 +165,15 @@ public static class MsBuildIssuesAliases } /// - /// Gets an instance of a provider for code analysis issues reported as MsBuild warnings using log content. + /// Gets an instance of a provider for issues reported as MsBuild warnings using log content. /// /// The context. /// Content of the the MsBuild log file. /// The log file needs to be in the format as defined by the parameter. /// Format of the provided MsBuild log file. - /// Instance of a provider for code analysis issues reported as MsBuild warnings. + /// Instance of a provider for issues reported as MsBuild warnings. /// - /// Read code analysis issues reported as MsBuild warnings: + /// Read issues reported as MsBuild warnings: /// /// /// /// @@ -200,13 +200,13 @@ public static class MsBuildIssuesAliases } /// - /// Gets an instance of a provider for code analysis issues reported as MsBuild warnings using specified settings. + /// Gets an instance of a provider for issues reported as MsBuild warnings using specified settings. /// /// The context. /// Settings for reading the MSBuild log. - /// Instance of a provider for code analysis issues reported as MsBuild warnings. + /// Instance of a provider for issues reported as MsBuild warnings. /// - /// Read code analysis issues reported as MsBuild warnings: + /// Read issues reported as MsBuild warnings: /// /// /// /// diff --git a/src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs b/src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs index 0568ee6..026f706 100644 --- a/src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs +++ b/src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs @@ -4,7 +4,7 @@ using Core.Diagnostics; /// - /// Provider for code analysis issues reported as MsBuild warnings. + /// Provider for issues reported as MsBuild warnings. /// internal class MsBuildIssuesProvider : IssueProvider {