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

Commit 738b046

Browse files
committed
Add some comments
1 parent ace5498 commit 738b046

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

src/GitHub.Exports/Services/IGitHubServiceProvider.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,18 @@ Ret GetService<T, Ret>() where T : class
3131
/// or if it's null, the service will be removed without checking for ownership</param>
3232
void RemoveService(Type t, object owner);
3333

34+
/// <summary>
35+
/// Gets a Visual Studio service asynchronously.
36+
/// </summary>
37+
/// <typeparam name="T">The type of the service.</typeparam>
3438
Task<T> GetServiceAsync<T>() where T : class;
3539

40+
/// <summary>
41+
/// Gets a Visual Studio service asynchronously.
42+
/// </summary>
43+
/// <typeparam name="T">The type of the service.</typeparam>
44+
/// <typeparam name="Ret">The type of the service instance to return.</typeparam>
45+
/// <returns></returns>
3646
[SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter")]
3747
Task<Ret> GetServiceAsync<T, Ret>() where T : class where Ret : class;
3848
}

src/GitHub.TeamFoundation.14/Services/VSGitExt.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ namespace GitHub.VisualStudio.Base
1717
/// </summary>
1818
/// <remarks>
1919
/// Initialization for this service will be done asynchronously and the <see cref="IGitExt" /> service will be
20-
/// retrieved on the Main thread. This means the service can be constructed and subscribed to on a background thread.
20+
/// retrieved using <see cref="GetServiceAsync" />. This means the service can be constructed and subscribed to from a background thread.
2121
/// </remarks>
2222
public class VSGitExt : IVSGitExt
2323
{

src/GitHub.VisualStudio/GitHubPackage.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,7 @@ async Task<object> CreateService(IAsyncServiceContainer container, CancellationT
300300

301301
IVSGitExt CreateVSGitExt(string dteVersion, IGitHubServiceProvider sp)
302302
{
303+
// DTE.Version always ends with ".0" even for later minor versions.
303304
switch (dteVersion)
304305
{
305306
case "14.0":

0 commit comments

Comments
 (0)