Code cleanup

Author: StanleyGoldman

src/GitHub.App/SampleData/PullRequestCheckViewModelDesigner.cs

@@ -19,9 +19,9 @@ public sealed class PullRequestCheckViewModelDesigner : ViewModelBase, IPullRequ
 
         public ReactiveCommand<object> OpenDetailsUrl { get; set; } = null;
 
-        public PullRequestCheckType CheckType { get; }
+        public PullRequestCheckType CheckType { get; set; } = PullRequestCheckType.ChecksApi;
 
-        public int CheckRunId { get; }
+        public int CheckRunId { get; set; }
 
         public bool HasAnnotations { get; } = true;
     }

src/GitHub.App/ViewModels/GitHubPane/GitHubPaneViewModel.cs

@@ -328,6 +328,7 @@ public Task ShowPullRequestReviews(string owner, string repo, int number, string
                      x.User.Login == login);
         }
 
+        /// <inheritdoc/>
         public Task ShowPullRequestCheckRun(string owner, string repo, int number, int checkRunId)
         {
             Guard.ArgumentNotNull(owner, nameof(owner));

src/GitHub.App/ViewModels/GitHubPane/PullRequestAnnotationItemViewModel.cs

@@ -5,6 +5,9 @@
 
 namespace GitHub.App.ViewModels.GitHubPane
 {
+    /// <summary>
+    /// The viewmodel for a single annotation item in a list
+    /// </summary>
     public class PullRequestAnnotationItemViewModel : ViewModelBase, IPullRequestAnnotationItemViewModel
     {
         bool isExpanded;
@@ -14,10 +17,19 @@ public PullRequestAnnotationItemViewModel(CheckRunAnnotationModel annotation)
             this.Annotation = annotation;
         }
 
+        /// <summary>
+        /// Gets the annotation model.
+        /// </summary>
         public CheckRunAnnotationModel Annotation { get; }
 
+        /// <summary>
+        /// Gets a formatted descriptor of the line(s) the annotation is about.
+        /// </summary>
         public string LineDescription => $"{Annotation.StartLine}:{Annotation.EndLine}";
 
+        /// <summary>
+        /// Gets or sets a flag to control the expanded state.
+        /// </summary>
         public bool IsExpanded
         {
             get { return isExpanded; }

src/GitHub.App/ViewModels/GitHubPane/PullRequestAnnotationsViewModel.cs

@@ -10,6 +10,9 @@
 
 namespace GitHub.App.ViewModels.GitHubPane
 {
+    /// <summary>
+    /// A viewmodel which displays a list of annotations for a pull request's check run.
+    /// </summary>
     [Export(typeof(IPullRequestAnnotationsViewModel))]
     [PartCreationPolicy(CreationPolicy.NonShared)]
     public class PullRequestAnnotationsViewModel : PanePageViewModelBase, IPullRequestAnnotationsViewModel
@@ -21,6 +24,10 @@ public class PullRequestAnnotationsViewModel : PanePageViewModelBase, IPullReque
         string checkRunName;
         IReadOnlyList<IPullRequestAnnotationItemViewModel> annotations;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PullRequestAnnotationsViewModel"/> class.
+        /// </summary>
+        /// <param name="sessionManager">The pull request session manager.</param>
         [ImportingConstructor]
         public PullRequestAnnotationsViewModel(IPullRequestSessionManager sessionManager)
         {
@@ -29,9 +36,9 @@ public PullRequestAnnotationsViewModel(IPullRequestSessionManager sessionManager
                 NavigateTo(FormattableString.Invariant($"{LocalRepository.Owner}/{LocalRepository.Name}/pull/{PullRequestNumber}")));
         }
 
+        /// <inheritdoc/>
         public async Task InitializeAsync(ILocalRepositoryModel localRepository, IConnection connection, string owner,
-            string repo,
-            int pullRequestNumber, int checkRunId)
+            string repo, int pullRequestNumber, int checkRunId)
         {
             if (repo != localRepository.Name)
             {

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

@@ -26,12 +26,40 @@ public interface IPullRequestAnnotationsViewModel : IPanePageViewModel
         /// </summary>
         int PullRequestNumber { get; }
 
-        int CheckRunId { get; }
-        ReactiveCommand<object> NavigateToPullRequest { get; }
+        /// <summary>
+        /// Gets the title of the pull request.
+        /// </summary>
         string PullRequestTitle { get; }
+
+        /// <summary>
+        /// Gets the id of the check run.
+        /// </summary>
+        int CheckRunId { get; }
+
+        /// <summary>
+        /// Gets the name of the check run.
+        /// </summary>
         string CheckRunName { get; }
+
+        /// <summary>
+        /// Gets a command which navigates to the parent pull request.
+        /// </summary>
+        ReactiveCommand<object> NavigateToPullRequest { get; }
+
+        /// <summary>
+        /// Gets the list of annotations.
+        /// </summary>
         IReadOnlyList<IPullRequestAnnotationItemViewModel> Annotations { get; }
 
+        /// <summary>
+        /// Initializes the view model.
+        /// </summary>
+        /// <param name="localRepository">The local repository.</param>
+        /// <param name="connection">The connection to the repository host.</param>
+        /// <param name="owner">The pull request's repository owner.</param>
+        /// <param name="repo">The pull request's repository name.</param>
+        /// <param name="pullRequestNumber">The pull request's number.</param>
+        /// <param name="checkRunId">The pull request's check run id.</param>
         Task InitializeAsync(
             ILocalRepositoryModel localRepository,
             IConnection connection,

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

@@ -175,10 +175,13 @@ public interface IPullRequestDetailViewModel : IPanePageViewModel, IOpenInBrowse
         /// </summary>
         ReactiveCommand<object> ShowReview { get; }
 
+        /// <summary>
+        /// Gets a command that navigates to a pull request's check run annotation list.
+        /// </summary>
         ReactiveCommand<object> ShowAnnotations { get; }
 
         /// <summary>
-        /// Gets the latest pull request Checks & Statuses
+        /// Gets the latest pull request checks & statuses.
         /// </summary>
         IReadOnlyList<IPullRequestCheckViewModel> Checks { get; }
 

src/GitHub.Exports/ViewModels/GitHubPane/IGitHubPaneViewModel.cs

@@ -91,6 +91,15 @@ public interface IGitHubPaneViewModel : IViewModel
         /// <param name="number">The pull rqeuest number.</param>
         Task ShowPullRequest(string owner, string repo, int number);
 
+        /// <summary>
+        /// Shows the details for a pull request's check run in the GitHub pane.
+        /// </summary>
+        /// <param name="owner">The repository owner.</param>
+        /// <param name="repo">The repository name.</param>
+        /// <param name="number">The pull rqeuest number.</param>
+        /// <param name="checkRunId">The check run number.</param>
+        Task ShowPullRequestCheckRun(string owner, string repo, int number, int checkRunId);
+
         /// <summary>
         /// Shows the pull requests reviews authored by a user.
         /// </summary>