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

Commit 0039538

Browse files
committed
Add some xmldoc comments
1 parent 20879e7 commit 0039538

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

src/GitHub.InlineReviews/PullRequestStatusBarPackage.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ namespace GitHub.InlineReviews
1515
[ProvideAutoLoad(Guids.GitSccProviderId)]
1616
public class PullRequestStatusBarPackage : AsyncPackage
1717
{
18+
/// <summary>
19+
/// Initialize the PR status UI on Visual Studio's status bar.
20+
/// </summary>
1821
protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
1922
{
2023
var componentModel = (IComponentModel)await GetServiceAsync(typeof(SComponentModel));

src/GitHub.InlineReviews/Services/IPullRequestStatusBarManager.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ namespace GitHub.InlineReviews.Services
44
{
55
public interface IPullRequestStatusBarManager
66
{
7+
/// <summary>
8+
/// Place the PR status control on Visual Studio's status bar.
9+
/// </summary>
10+
/// <param name="mainWindow">The main window of Visual Studio.</param>
711
void Initialize(Window mainWindow);
812
}
913
}

src/GitHub.InlineReviews/Services/PullRequestStatusBarManager.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ public PullRequestStatusBarManager(IVSGitExt gitExt, Lazy<IPullRequestSessionMan
4242
this.serviceProvider = serviceProvider;
4343
}
4444

45+
/// <summary>
46+
/// Lazily initialize when user enters the context of a GitHub repository.
47+
/// </summary>
48+
/// <param name="window">Visual Studio's main window.</param>
4549
public void Initialize(Window window)
4650
{
4751
mainWindow = window;

0 commit comments

Comments
 (0)