Improve comments

cake-contrib · Sep 13, 2017 · 6cb42ef · 6cb42ef
1 parent 23df4ca
commit 6cb42ef
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 10 deletions.
diff --git a/src/Cake.Issues.PullRequests.Tfs/TfsPullRequestSettings.cs b/src/Cake.Issues.PullRequests.Tfs/TfsPullRequestSettings.cs
@@ -3,7 +3,7 @@
     using System;
 
     /// <summary>
-    /// Settings for <see cref="TfsPullRequestSystem"/>.
+    /// Settings for <see cref="TfsPullRequestSystemAliases"/>.
     /// </summary>
     public class TfsPullRequestSettings
     {

diff --git a/src/Cake.Issues.PullRequests.Tfs/TfsPullRequestSystemAliases.cs b/src/Cake.Issues.PullRequests.Tfs/TfsPullRequestSystemAliases.cs
@@ -127,16 +127,15 @@ public static ITfsCredentials TfsAuthenticationAzureActiveDirectory(
         /// <para>Report code analysis issues reported as MsBuild warnings to a TFS pull request:</para>
         /// <code>
         /// <![CDATA[
-        ///     var repoRoot = new DirectoryPath("c:\repo");
         ///     ReportIssuesToPullRequest(
         ///         MsBuildCodeAnalysis(
-        ///             @"C:\build\msbuild.log",
+        ///             @"c:\build\msbuild.log",
         ///             MsBuildXmlFileLoggerFormat),
         ///         TfsPullRequests(
         ///             new Uri("http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository"),
         ///             "refs/heads/feature/myfeature",
         ///             TfsAuthenticationNtlm()),
-        ///         repoRoot);
+        ///         @"c:\repo");
         /// ]]>
         /// </code>
         /// </example>
@@ -173,16 +172,15 @@ public static IPullRequestSystem TfsPullRequests(
         /// <para>Report code analysis issues reported as MsBuild warnings to a TFS pull request:</para>
         /// <code>
         /// <![CDATA[
-        ///     var repoRoot = new DirectoryPath("c:\repo");
         ///     ReportIssuesToPullRequest(
         ///         MsBuildCodeAnalysis(
-        ///             @"C:\build\msbuild.log",
+        ///             @"c:\build\msbuild.log",
         ///             MsBuildXmlFileLoggerFormat),
         ///         TfsPullRequests(
         ///             new Uri("http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository"),
         ///             5,
         ///             TfsAuthenticationNtlm()),
-        ///         repoRoot);
+        ///         @"c:\repo");
         /// ]]>
         /// </code>
         /// </example>
@@ -212,7 +210,6 @@ public static IPullRequestSystem TfsPullRequests(
         /// <para>Report code analysis issues reported as MsBuild warnings to a TFS pull request:</para>
         /// <code>
         /// <![CDATA[
-        ///     var repoRoot = new DirectoryPath("c:\repo");
         ///     var pullRequestSettings =
         ///         new TfsPullRequestSettings(
         ///             new Uri("http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository"),
@@ -221,10 +218,10 @@ public static IPullRequestSystem TfsPullRequests(
         ///
         ///     ReportCodeAnalysisIssuesToPullRequest(
         ///         MsBuildCodeAnalysis(
-        ///             @"C:\build\msbuild.log",
+        ///             @"c:\build\msbuild.log",
         ///             MsBuildXmlFileLoggerFormat),
         ///         TfsPullRequests(pullRequestSettings),
-        ///         repoRoot);
+        ///         @"c:\repo");
         /// ]]>
         /// </code>
         /// </example>