Skip to content
This repository has been archived by the owner on Dec 25, 2023. It is now read-only.

Commit

Permalink
Update comments
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalberger committed Sep 8, 2017
1 parent 0fa7201 commit 3d22f90
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
Expand Up @@ -6,7 +6,7 @@

public class MsBuildIssuesProviderTests
{
public sealed class TheMsBuildCodeAnalysisProviderCtor
public sealed class TheCtor
{
[Fact]
public void Should_Throw_If_Log_Is_Null()
Expand Down
Expand Up @@ -11,7 +11,7 @@

public class MsBuildIssuesSettingsTests
{
public sealed class TheMsBuildCodeAnalysisSettingsCtor
public sealed class TheCtor
{
[Fact]
public void Should_Throw_If_LogFilePath_Is_Null()
Expand Down
6 changes: 3 additions & 3 deletions src/Cake.Issues.MsBuild/ILogFileFormat.cs
Expand Up @@ -8,11 +8,11 @@
public interface ILogFileFormat
{
/// <summary>
/// Gets all code analysis issues.
/// Gets all issues.
/// </summary>
/// <param name="repositorySettings">Repository settings to use.</param>
/// <param name="msBuildIssuesSettings">Settings for code analysis provider to use.</param>
/// <returns>List of code analysis issues</returns>
/// <param name="msBuildIssuesSettings">Settings for issue provider to use.</param>
/// <returns>List of issues</returns>
IEnumerable<IIssue> ReadIssues(
RepositorySettings repositorySettings,
MsBuildIssuesSettings msBuildIssuesSettings);
Expand Down
24 changes: 12 additions & 12 deletions src/Cake.Issues.MsBuild/MsBuildIssuesAliases.cs
Expand Up @@ -130,23 +130,23 @@ public static class MsBuildIssuesAliases
}

/// <summary>
/// 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.
/// </summary>
/// <param name="context">The context.</param>
/// <param name="logFilePath">Path to the the MsBuild log file.
/// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
/// <param name="format">Format of the provided MsBuild log file.</param>
/// <returns>Instance of a provider for code analysis issues reported as MsBuild warnings.</returns>
/// <returns>Instance of a provider for issues reported as MsBuild warnings.</returns>
/// <example>
/// <para>Read code analysis issues reported as MsBuild warnings:</para>
/// <para>Read issues reported as MsBuild warnings:</para>
/// <code>
/// <![CDATA[
/// var issues =
/// ReadIssues(
/// MsBuildIssuesFromFilePath(
/// new FilePath(@"c:\build\InspectCode.log"),
/// MsBuildXmlFileLoggerFormat),
/// new DirectoryPath(@"c:\repo")));
/// new DirectoryPath(@"c:\repo"));
/// ]]>
/// </code>
/// </example>
Expand All @@ -165,23 +165,23 @@ public static class MsBuildIssuesAliases
}

/// <summary>
/// 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.
/// </summary>
/// <param name="context">The context.</param>
/// <param name="logFileContent">Content of the the MsBuild log file.
/// The log file needs to be in the format as defined by the <paramref name="format"/> parameter.</param>
/// <param name="format">Format of the provided MsBuild log file.</param>
/// <returns>Instance of a provider for code analysis issues reported as MsBuild warnings.</returns>
/// <returns>Instance of a provider for issues reported as MsBuild warnings.</returns>
/// <example>
/// <para>Read code analysis issues reported as MsBuild warnings:</para>
/// <para>Read issues reported as MsBuild warnings:</para>
/// <code>
/// <![CDATA[
/// var issues =
/// ReadIssues(
/// MsBuildIssuesFromContent(
/// logFileContent,
/// MsBuildXmlFileLoggerFormat)),
/// new DirectoryPath(@"c:\repo")));
/// new DirectoryPath(@"c:\repo"));
/// ]]>
/// </code>
/// </example>
Expand All @@ -200,13 +200,13 @@ public static class MsBuildIssuesAliases
}

/// <summary>
/// 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.
/// </summary>
/// <param name="context">The context.</param>
/// <param name="settings">Settings for reading the MSBuild log.</param>
/// <returns>Instance of a provider for code analysis issues reported as MsBuild warnings.</returns>
/// <returns>Instance of a provider for issues reported as MsBuild warnings.</returns>
/// <example>
/// <para>Read code analysis issues reported as MsBuild warnings:</para>
/// <para>Read issues reported as MsBuild warnings:</para>
/// <code>
/// <![CDATA[
/// var settings =
Expand All @@ -217,7 +217,7 @@ public static class MsBuildIssuesAliases
/// var issues =
/// ReadIssues(
/// MsBuildIssues(settings),
/// new DirectoryPath(@"c:\repo")));
/// new DirectoryPath(@"c:\repo"));
/// ]]>
/// </code>
/// </example>
Expand Down
2 changes: 1 addition & 1 deletion src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs
Expand Up @@ -4,7 +4,7 @@
using Core.Diagnostics;

/// <summary>
/// Provider for code analysis issues reported as MsBuild warnings.
/// Provider for issues reported as MsBuild warnings.
/// </summary>
internal class MsBuildIssuesProvider : IssueProvider
{
Expand Down

0 comments on commit 3d22f90

Please sign in to comment.