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

Commit 57b4f31

Browse files
Adding some xmlcomments
1 parent 01efca2 commit 57b4f31

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

src/GitHub.Exports.Reactive/ViewModels/GitHubPane/IPullRequestCheckViewModel.cs

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,45 @@
55

66
namespace GitHub.ViewModels.GitHubPane
77
{
8+
/// <summary>
9+
/// Represents a view model for displaying details of a pull request Status or Check.
10+
/// </summary>
811
public interface IPullRequestCheckViewModel: IViewModel
912
{
13+
/// <summary>
14+
/// The title of the Status/Check
15+
/// </summary>
1016
string Title { get; }
17+
18+
/// <summary>
19+
/// The description of the Status/Check
20+
/// </summary>
1121
string Description { get; }
22+
23+
/// <summary>
24+
/// The status of the Status/Check
25+
/// </summary>
1226
PullRequestCheckStatus Status { get; }
27+
28+
/// <summary>
29+
/// The url where more information about the Status/Check can be found
30+
/// </summary>
1331
Uri DetailsUrl { get; }
32+
33+
/// <summary>
34+
/// The AvatarUrl of the Status/Check application
35+
/// </summary>
1436
string AvatarUrl { get; }
37+
38+
/// <summary>
39+
/// The BitmapImage of the AvatarUrl
40+
/// </summary>
1541
BitmapImage Avatar { get; }
42+
43+
/// <summary>
44+
/// A command that opens the DetailsUrl in a browser
45+
/// </summary>
46+
1647
ReactiveCommand<object> OpenDetailsUrl { get; }
1748
}
1849

src/GitHub.Exports.Reactive/ViewModels/GitHubPane/IPullRequestDetailViewModel.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,11 @@ public interface IPullRequestDetailViewModel : IPanePageViewModel, IOpenInBrowse
175175
/// </summary>
176176
ReactiveCommand<object> ShowReview { get; }
177177

178+
179+
/// <summary>
180+
/// Gets the latest pull request Checks & Statuses
181+
/// </summary>
182+
178183
IReadOnlyList<IPullRequestCheckViewModel> Checks { get; }
179184

180185
/// <summary>

0 commit comments

Comments
 (0)