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

Commit edbec49

Browse files
committed
Make <summary> xmldoc elements a single sentence
1 parent 22ec886 commit edbec49

File tree

4 files changed

+15
-6
lines changed

4 files changed

+15
-6
lines changed

src/GitHub.Exports/Commands/IOpenFromClipboardCommand.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
namespace GitHub.Commands
22
{
33
/// <summary>
4+
/// Open a file in the current repository based on a URL in the clipboard.
5+
/// </summary>
6+
/// <remarks>
47
/// This command appears as `Code context > GitHub > Open from clipboard`.
58
///
69
/// Open a working directory file at the same location as a GitHub URL in the clipboard. If the URL links to
710
/// a line or range of lines, these lines will be selected. If the working directory file is different to the
811
/// target file, the target file will be opened in the `Blame (Annotate)` view. If the URL is from a different
912
/// fork, it will still open the target file assuming that the target commit/branch exists.
10-
/// </summary>
11-
/// <remarks>
1213
/// Currently only GitHub `blob` URLs are supported. In a future version we can add support for `pull`, `issue`,
1314
/// `tree`, `commits`, `blame` and any other URL types that might make sense.
1415
/// </remarks>

src/GitHub.Exports/Commands/IOpenFromUrlCommand.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
namespace GitHub.Commands
22
{
33
/// <summary>
4+
/// Open a repository from a URL in the clipboard.
5+
/// </summary>
6+
/// <remarks>
47
/// This appears as the named command `GitHub.OpenFromUrl` and must be bound to a keyboard shortcut or executed
58
/// via the `Command Window`. In future it will appear on `File > Open > Open from GitHub`.
69
///
710
/// When executed it will offer to clone, open and navigate to the file pointed to by a URL in the clipboard.
811
/// This spike uses Yes/No/Cancel dialogs, but the final version will use a UI to control what action is performed
912
/// and allow the user to override the default repository location.
10-
/// </summary>
13+
/// </remarks>
1114
public interface IOpenFromUrlCommand : IVsCommand<string>
1215
{
1316
}

src/GitHub.Exports/Services/GitHubContext.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44
namespace GitHub.Services
55
{
66
/// <summary>
7-
/// Information used to map betwen a GitHub URL and some other context. This might be used to navigate
8-
/// between a GitHub URL and the location a repository file. Alternatively it might be used to map between
9-
/// the line a in a blame view and GitHub URL.
7+
/// Information used to map betwen a GitHub URL and some other context.
108
/// </summary>
9+
/// <remarks>
10+
/// This might be used to navigate between a GitHub URL and the location a repository file. Alternatively it
11+
/// might be used to map between the line in a blame view and GitHub URL.
12+
/// </remarks>
1113
public class GitHubContext
1214
{
1315
/// <summary>

src/GitHub.Exports/Services/IGitHubContextService.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
namespace GitHub.Services
55
{
6+
/// <summary>
7+
/// Methods for constructing a <see cref="GitHubContext"/> and navigating based on a <see cref="GitHubContext"/>.
8+
/// </summary>
69
public interface IGitHubContextService
710
{
811
/// <summary>

0 commit comments

Comments
 (0)