Skip to content
This repository was archived by the owner on Jun 21, 2023. It is now read-only.

Commit c3da975

Browse files
committed
Improve xmldoc description on TextViewCommandDispatcher
1 parent 3a4774c commit c3da975

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/GitHub.VisualStudio/Views/GitHubPane/TextViewCommandDispatcher.cs

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,12 @@
66
namespace GitHub.VisualStudio.Views.GitHubPane
77
{
88
/// <summary>
9-
/// Used to filter commands send to <see cref="IVsTextView"/> dispatch them to a <see cref="Exec"/> event.
9+
/// Intercepts all commands sent to a <see cref="IVsTextView"/> and fires <see href="Exec"/> when a specified command is encountered.
1010
/// </summary>
11+
/// <remarks>
12+
/// Intercepting commands like this is necessary if we want to capture commands in context of a <see cref="IVsTextView"/>.
13+
/// Well known commands like Copy, Paste and Enter can be captured as well as custom commands.
14+
/// </remarks>
1115
class TextViewCommandDispatcher : IOleCommandTarget, IDisposable
1216
{
1317
readonly IVsTextView textView;
@@ -19,8 +23,8 @@ class TextViewCommandDispatcher : IOleCommandTarget, IDisposable
1923
/// Add a command filter to <see cref="IVsTextView"/>.
2024
/// </summary>
2125
/// <param name="textView">The text view to filter commands from.</param>
22-
/// <param name="commandGroup">The group of the command to filter.</param>
23-
/// <param name="commandId">The ID of the command to filter.</param>
26+
/// <param name="commandGroup">The group of the command to listen for.</param>
27+
/// <param name="commandId">The ID of the command to listen for.</param>
2428
public TextViewCommandDispatcher(IVsTextView textView, Guid commandGroup, int commandId)
2529
{
2630
this.textView = textView;

0 commit comments

Comments
 (0)