Use <inheritdoc/> on members not classes!

Author: jcansdale

src/GitHub.App/Services/GitHubContextService.cs

@@ -20,7 +20,6 @@
 
 namespace GitHub.Services
 {
-    /// <inheritdoc/>
     [Export(typeof(IGitHubContextService))]
     public class GitHubContextService : IGitHubContextService
     {
@@ -67,21 +66,14 @@ public GitHubContextService(IGitHubServiceProvider serviceProvider, IGitService
             textManager = new Lazy<IVsTextManager2>(() => serviceProvider.GetService<SVsTextManager, IVsTextManager2>());
         }
 
-        /// <summary>
-        /// Find the context from a URL in the clipboard if any.
-        /// </summary>
-        /// <returns>The context or null if clipboard doesn't contain a GitHub URL</returns>
+        /// <inheritdoc/>
         public GitHubContext FindContextFromClipboard()
         {
             var text = Clipboard.GetText(TextDataFormat.Text);
             return FindContextFromUrl(text);
         }
 
-        /// <summary>
-        /// Convert a GitHub URL to a context object.
-        /// </summary>
-        /// <param name="url">A GitHub URL</param>
-        /// <returns>The context from the URL or null</returns>
+        /// <inheritdoc/>
         public GitHubContext FindContextFromUrl(string url)
         {
             var uri = new UriString(url);
@@ -127,10 +119,7 @@ public GitHubContext FindContextFromUrl(string url)
             return context;
         }
 
-        /// <summary>
-        /// Find the context from the title of the topmost browser.
-        /// </summary>
-        /// <returns>A context or null if a context can't be found.</returns>
+        /// <inheritdoc/>
         public GitHubContext FindContextFromBrowser()
         {
             return
@@ -140,23 +129,15 @@ public GitHubContext FindContextFromBrowser()
                 .FirstOrDefault();
         }
 
-        /// <summary>
-        /// Convert a context to a repository URL.
-        /// </summary>
-        /// <param name="context">The context to convert.</param>
-        /// <returns>A repository URL</returns>
+        /// <inheritdoc/>
         public Uri ToRepositoryUrl(GitHubContext context)
         {
             var builder = new UriBuilder("https", context.Host ?? "github.com");
             builder.Path = $"{context.Owner}/{context.RepositoryName}";
             return builder.Uri;
         }
 
-        /// <summary>
-        /// Find a context from a browser window title.
-        /// </summary>
-        /// <param name="windowTitle">A browser window title.</param>
-        /// <returns>The context or null if none can be found</returns>
+        /// <inheritdoc/>
         public GitHubContext FindContextFromWindowTitle(string windowTitle)
         {
             var match = windowTitleBlobRegex.Match(windowTitle);
@@ -243,12 +224,7 @@ public GitHubContext FindContextFromWindowTitle(string windowTitle)
             return null;
         }
 
-        /// <summary>
-        /// Open a file in the working directory that corresponds to a context and navigate to a line/range.
-        /// </summary>
-        /// <param name="repositoryDir">The working directory.</param>
-        /// <param name="context">A context to navigate to.</param>
-        /// <returns>True if navigation was successful</returns>
+        /// <inheritdoc/>
         public bool TryOpenFile(string repositoryDir, GitHubContext context)
         {
             var (commitish, path, isSha) = ResolveBlob(repositoryDir, context);
@@ -263,13 +239,7 @@ public bool TryOpenFile(string repositoryDir, GitHubContext context)
             return true;
         }
 
-        /// <summary>
-        /// Map from a context to a repository blob object.
-        /// </summary>
-        /// <param name="repositoryDir">The target repository.</param>
-        /// <param name="context">The context to map from.</param>
-        /// <param name="remoteName">The name of the remote to search for branches.</param>
-        /// <returns>The resolved commit-ish, blob path and commit SHA for the blob. Path will be null if the commit-ish can be resolved but not the blob.</returns>
+        /// <inheritdoc/>
         public (string commitish, string path, string commitSha) ResolveBlob(string repositoryDir, GitHubContext context, string remoteName = "origin")
         {
             Guard.ArgumentNotNull(repositoryDir, nameof(repositoryDir));
@@ -335,16 +305,7 @@ public bool TryOpenFile(string repositoryDir, GitHubContext context)
             }
         }
 
-        /// <summary>
-        /// Check if a file in the working directory has changed since a specified commit-ish.
-        /// </summary>
-        /// <remarks>
-        /// The commit-ish might be a commit SHA, a tag or a remote branch.
-        /// </remarks>
-        /// <param name="repositoryDir">The target repository.</param>
-        /// <param name="commitish">A commit SHA, remote branch or tag.</param>
-        /// <param name="path">The path for a blob.</param>
-        /// <returns>True if the working file is different.</returns>
+        /// <inheritdoc/>
         public bool HasChangesInWorkingDirectory(string repositoryDir, string commitish, string path)
         {
             using (var repo = gitService.GetRepository(repositoryDir))
@@ -356,17 +317,7 @@ public bool HasChangesInWorkingDirectory(string repositoryDir, string commitish,
             }
         }
 
-        /// <summary>
-        /// Attempt to open the Blame/Annotate view for a context.
-        /// </summary>
-        /// <remarks>
-        /// The access to the Blame/Annotate view was added in a version of Visual Studio 2017. This method will return
-        /// false is this functionality isn't available.
-        /// </remarks>
-        /// <param name="repositoryDir">The target repository</param>
-        /// <param name="currentBranch">A branch in the local repository. It isn't displayed on the UI but must exist. It can be a remote or local branch.</param>
-        /// <param name="context">The context to open.</param>
-        /// <returns>True if AnnotateFile functionality is available.</returns>
+        /// <inheritdoc/>
         public async Task<bool> TryAnnotateFile(string repositoryDir, string currentBranch, GitHubContext context)
         {
             var (commitish, path, commitSha) = ResolveBlob(repositoryDir, context);

src/GitHub.Exports/Services/VSServices.cs

@@ -36,6 +36,7 @@ public VSServices(IGitHubServiceProvider serviceProvider, ILogger log)
         }
 
         string vsVersion;
+        /// <inheritdoc/>
         public string VSVersion
         {
             get
@@ -46,6 +47,7 @@ public string VSVersion
             }
         }
 
+        /// <inheritdoc/>
         public VSConstants.MessageBoxResult ShowMessageBoxInfo(string message)
         {
             return (VSConstants.MessageBoxResult)VsShellUtilities.ShowMessageBox(serviceProvider, message, null,

src/GitHub.VisualStudio/Commands/OpenFromClipboardCommand.cs

@@ -9,7 +9,6 @@
 
 namespace GitHub.VisualStudio.Commands
 {
-    /// <inheritdoc/>
     [Export(typeof(IOpenFromClipboardCommand))]
     public class OpenFromClipboardCommand : VsCommand<string>, IOpenFromClipboardCommand
     {

src/GitHub.VisualStudio/Commands/OpenFromUrlCommand.cs

@@ -15,7 +15,6 @@
 
 namespace GitHub.VisualStudio.Commands
 {
-    /// <inheritdoc/>
     [Export(typeof(IOpenFromUrlCommand))]
     public class OpenFromUrlCommand : VsCommand<string>, IOpenFromUrlCommand
     {