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

Commit 12376fa

Browse files
committed
Add xmldoc comment for GoToSolutionOrPRFileCommand
1 parent fb919dc commit 12376fa

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

src/GitHub.Exports/Commands/IGoToSolutionOrPullRequestFileCommand.cs

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,14 @@
1-
using GitHub.Commands;
2-
3-
namespace GitHub.Commands
1+
namespace GitHub.Commands
42
{
3+
/// <summary>
4+
/// Navigate from a PR file to the equivalent file and location in the editor (or the reverse).
5+
/// </summary>
6+
/// <remarks>
7+
/// This command will do one of the following depending on context.
8+
/// Navigate from PR file diff to the working file in the solution.
9+
/// Navigate from the working file in the solution to the PR file diff.
10+
/// Navigate from an editable diff (e.g. 'View Changes in Solution') to the editor view.
11+
/// </remarks>
512
public interface IGoToSolutionOrPullRequestFileCommand : IVsCommand
613
{
714
}

src/GitHub.VisualStudio/Commands/GoToSolutionOrPullRequestFileCommand.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,15 @@
1414

1515
namespace GitHub.Commands
1616
{
17+
/// <summary>
18+
/// Navigate from a PR file to the equivalent file and location in the editor (or the reverse).
19+
/// </summary>
20+
/// <remarks>
21+
/// This command will do one of the following depending on context.
22+
/// Navigate from PR file diff to the working file in the solution.
23+
/// Navigate from the working file in the solution to the PR file diff.
24+
/// Navigate from an editable diff (e.g. 'View Changes in Solution') to the editor view.
25+
/// </remarks>
1726
[Export(typeof(IGoToSolutionOrPullRequestFileCommand))]
1827
public class GoToSolutionOrPullRequestFileCommand : VsCommand, IGoToSolutionOrPullRequestFileCommand
1928
{

0 commit comments

Comments
 (0)