Added/updated view model XML docs.

And removed unused classes and members.

Author: grokys

src/GitHub.App/SampleData/PullRequestListItemViewModelDesigner.cs

@@ -13,7 +13,6 @@ public class PullRequestListItemViewModelDesigner : ViewModelBase, IPullRequestL
         public IActorViewModel Author { get; set; }
         public int CommentCount { get; set; }
         public bool IsCurrent { get; set; }
-        public IReadOnlyList<ILabelViewModel> Labels { get; set; }
         public int Number { get; set; }
         public string Title { get; set; }
         public DateTimeOffset UpdatedAt { get; set; }

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

@@ -16,6 +16,9 @@
 
 namespace GitHub.ViewModels.GitHubPane
 {
+    /// <summary>
+    /// A view model which implements the functionality common to issue and pull request lists.
+    /// </summary>
     public abstract class IssueListViewModelBase : PanePageViewModelBase, IIssueListViewModelBase
     {
         readonly IRepositoryService repositoryService;
@@ -31,66 +34,82 @@ public abstract class IssueListViewModelBase : PanePageViewModelBase, IIssueList
         int numberFilter;
         IUserFilterViewModel authorFilter;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="IssueListViewModelBase"/> class.
+        /// </summary>
+        /// <param name="repositoryService">The repository service.</param>
         public IssueListViewModelBase(IRepositoryService repositoryService)
         {
             this.repositoryService = repositoryService;
             OpenItem = ReactiveCommand.CreateAsyncTask(OpenItemImpl);
         }
 
+        /// <inheritdoc/>
         public IUserFilterViewModel AuthorFilter
         {
             get { return authorFilter; }
             private set { this.RaiseAndSetIfChanged(ref authorFilter, value); }
         }
 
+        /// <inheritdoc/>
         public IReadOnlyList<IRepositoryModel> Forks
         {
             get { return forks; }
             set { this.RaiseAndSetIfChanged(ref forks, value); }
         }
 
+        /// <inheritdoc/>
         public IReadOnlyList<IIssueListItemViewModelBase> Items
         {
             get { return items; }
             private set { this.RaiseAndSetIfChanged(ref items, value); }
         }
 
+        /// <inheritdoc/>
         public ICollectionView ItemsView
         {
             get { return itemsView; }
             private set { this.RaiseAndSetIfChanged(ref itemsView, value); }
         }
 
+        /// <inheritdoc/>
         public ILocalRepositoryModel LocalRepository { get; private set; }
 
+        /// <inheritdoc/>
         public IssueListMessage Message
         {
             get { return message; }
             private set { this.RaiseAndSetIfChanged(ref message, value); }
         }
 
+        /// <inheritdoc/>
         public IRepositoryModel RemoteRepository
         {
             get { return remoteRepository; }
             set { this.RaiseAndSetIfChanged(ref remoteRepository, value); }
         }
 
+        /// <inheritdoc/>
         public string SearchQuery
         {
             get { return searchQuery; }
             set { this.RaiseAndSetIfChanged(ref searchQuery, value); }
         }
 
+        /// <inheritdoc/>
         public string SelectedState
         {
             get { return selectedState; }
             set { this.RaiseAndSetIfChanged(ref selectedState, value); }
         }
 
+        /// <inheritdoc/>
         public abstract IReadOnlyList<string> States { get; }
 
+        /// <inheritdoc/>
         public ReactiveCommand<Unit> OpenItem { get; }
 
+        /// <inheritdoc/>
         public async Task InitializeAsync(ILocalRepositoryModel repository, IConnection connection)
         {
             LocalRepository = repository;
@@ -132,6 +151,10 @@ public async Task InitializeAsync(ILocalRepositoryModel repository, IConnection
             await Refresh();
         }
 
+        /// <summary>
+        /// Refreshes the view model.
+        /// </summary>
+        /// <returns>A task tracking the operation.</returns>
         public override Task Refresh()
         {
             subscription?.Dispose();
@@ -157,8 +180,24 @@ public override Task Refresh()
             return Task.CompletedTask;
         }
 
+        /// <summary>
+        /// When overridden in a derived class, creates the <see cref="IVirtualizingListSource{T}"/>
+        /// that will act as the source for <see cref="Items"/>.
+        /// </summary>
         protected abstract IVirtualizingListSource<IIssueListItemViewModelBase> CreateItemSource();
+
+        /// <summary>
+        /// When overridden in a derived class, navigates to the specified item.
+        /// </summary>
+        /// <param name="item">The item.</param>
+        /// <returns>A task tracking the operation.</returns>
         protected abstract Task DoOpenItem(IIssueListItemViewModelBase item);
+
+        /// <summary>
+        /// Loads a page of authors for the <see cref="AuthorFilter"/>.
+        /// </summary>
+        /// <param name="after">The GraphQL "after" cursor.</param>
+        /// <returns>A task that returns a page of authors.</returns>
         protected abstract Task<Page<ActorModel>> LoadAuthors(string after);
 
         void FilterChanged()

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

@@ -1,14 +1,20 @@
 using System;
-using System.Collections.Generic;
 using GitHub.Models;
 using ReactiveUI;
 
 namespace GitHub.ViewModels.GitHubPane
 {
+    /// <summary>
+    /// A view model which displays an item in a <see cref="PullRequestListViewModel"/>.
+    /// </summary>
     public class PullRequestListItemViewModel : ViewModelBase, IPullRequestListItemViewModel
     {
         bool isCurrent;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PullRequestListItemViewModel"/> class.
+        /// </summary>
+        /// <param name="model">The underlying pull request item model.</param>
         public PullRequestListItemViewModel(PullRequestListItemModel model)
         {
             Id = model.Id;
@@ -19,24 +25,29 @@ public PullRequestListItemViewModel(PullRequestListItemModel model)
             UpdatedAt = model.UpdatedAt;
         }
 
+        /// <inheritdoc/>
         public string Id { get; protected set; }
 
+        /// <inheritdoc/>
         public IActorViewModel Author { get; protected set; }
 
+        /// <inheritdoc/>
         public int CommentCount { get; protected set; }
 
+        /// <inheritdoc/>
         public bool IsCurrent
         {
             get { return isCurrent; }
             internal set { this.RaiseAndSetIfChanged(ref isCurrent, value); }
         }
 
-        public IReadOnlyList<ILabelViewModel> Labels { get; protected set; }
-
+        /// <inheritdoc/>
         public int Number { get; protected set; }
 
+        /// <inheritdoc/>
         public string Title { get; protected set; }
 
+        /// <inheritdoc/>
         public DateTimeOffset UpdatedAt { get; protected set; }
     }
 }

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

@@ -13,6 +13,9 @@
 
 namespace GitHub.ViewModels.GitHubPane
 {
+    /// <summary>
+    /// A view model which displays a pull request list.
+    /// </summary>
     [Export(typeof(IPullRequestListViewModel))]
     [PartCreationPolicy(CreationPolicy.NonShared)]
     public class PullRequestListViewModel : IssueListViewModelBase, IPullRequestListViewModel
@@ -22,6 +25,12 @@ public class PullRequestListViewModel : IssueListViewModelBase, IPullRequestList
         readonly IPullRequestService service;
         readonly IDisposable subscription;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="PullRequestListViewModel"/> class.
+        /// </summary>
+        /// <param name="sessionManager">The session manager.</param>
+        /// <param name="repositoryService">The repository service.</param>
+        /// <param name="service">The pull request service.</param>
         [ImportingConstructor]
         public PullRequestListViewModel(
             IPullRequestSessionManager sessionManager,
@@ -39,22 +48,27 @@ public PullRequestListViewModel(
             CreatePullRequest = ReactiveCommand.Create().OnExecuteCompleted(_ => NavigateTo("pull/new"));
         }
 
+        /// <inheritdoc/>
         public override IReadOnlyList<string> States => states;
 
+        /// <inheritdoc/>
         public ReactiveCommand<object> CreatePullRequest { get; }
 
+        /// <inheritdoc/>
         protected override IVirtualizingListSource<IIssueListItemViewModelBase> CreateItemSource()
         {
             return new ItemSource(this);
         }
 
+        /// <inheritdoc/>
         protected override Task DoOpenItem(IIssueListItemViewModelBase item)
         {
             var i = (IPullRequestListItemViewModel)item;
             NavigateTo(Invariant($"{RemoteRepository.Owner}/{RemoteRepository.Name}/pull/{i.Number}"));
             return Task.CompletedTask;
         }
 
+        /// <inheritdoc/>
         protected override Task<Page<ActorModel>> LoadAuthors(string after)
         {
             return service.ReadAssignableUsers(

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

@@ -8,35 +8,98 @@
 
 namespace GitHub.ViewModels.GitHubPane
 {
+    /// <summary>
+    /// Describes a message that should be displayed in place of a list of items in
+    /// an <see cref="IIssueListItemViewModelBase"/>.
+    /// </summary>
     public enum IssueListMessage
     {
+        /// <summary>
+        /// No message should be displayed; the items should be displayed.
+        /// </summary>
         None,
+        
+        /// <summary>
+        /// A "No Open Items" message should be displayed.
+        /// </summary>
         NoOpenItems,
+
+        /// <summary>
+        /// A "No Items Match Search Criteria" message should be displayed.
+        /// </summary>
         NoItemsMatchCriteria,
     }
 
+    /// <summary>
+    /// Represents a view model which displays an issue or pull request list.
+    /// </summary>
     public interface IIssueListViewModelBase : ISearchablePageViewModel
     {
+        /// <summary>
+        /// Gets the filter view model.
+        /// </summary>
         IUserFilterViewModel AuthorFilter { get; }
 
+        /// <summary>
+        /// Gets a list consisting of the fork and parent repositories if the current repository is
+        /// a fork.
+        /// </summary>
+        /// <remarks>
+        /// Returns null if the current repository is not a fork.
+        /// </remarks>
         IReadOnlyList<IRepositoryModel> Forks { get; }
 
+        /// <summary>
+        /// Gets the list of issues or pull requests.
+        /// </summary>
         IReadOnlyList<IIssueListItemViewModelBase> Items { get; }
 
+        /// <summary>
+        /// Gets a filtered view of <see cref="Items"/> based on <see cref="SearchQuery"/> and
+        /// <see cref="AuthorFilter"/>.
+        /// </summary>
         ICollectionView ItemsView { get; }
 
+        /// <summary>
+        /// Gets the local repository.
+        /// </summary>
         ILocalRepositoryModel LocalRepository { get; }
 
+        /// <summary>
+        /// Gets an enum indicating a message that should be displayed in place of a list of items.
+        /// </summary>
         IssueListMessage Message { get; }
 
+        /// <summary>
+        /// Gets the remote repository.
+        /// </summary>
+        /// <remarks>
+        /// This may differ from <see cref="LocalRepository"/> if <see cref="LocalRepository"/> is
+        /// a fork.
+        /// </remarks>
         IRepositoryModel RemoteRepository { get; set; }
 
+        /// <summary>
+        /// Gets the currently selected item in <see cref="States"/>.
+        /// </summary>
         string SelectedState { get; set; }
 
+        /// <summary>
+        /// Gets a list of the available states (e.g. Open, Closed, All).
+        /// </summary>
         IReadOnlyList<string> States { get; }
 
+        /// <summary>
+        /// Gets a command which opens the item passed as a parameter.
+        /// </summary>
         ReactiveCommand<Unit> OpenItem { get; }
 
+        /// <summary>
+        /// Initializes the view model.
+        /// </summary>
+        /// <param name="repository">The local repository.</param>
+        /// <param name="connection">The connection/</param>
+        /// <returns>A task tracking the operation.</returns>
         Task InitializeAsync(ILocalRepositoryModel repository, IConnection connection);
     }
 }

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

@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Generic;
 
 namespace GitHub.ViewModels.GitHubPane
 {
@@ -9,12 +8,12 @@ namespace GitHub.ViewModels.GitHubPane
     public interface IPullRequestListItemViewModel : IIssueListItemViewModelBase
     {
         /// <summary>
-        /// Gets the ID of the issue or pull request.
+        /// Gets the ID of the pull request.
         /// </summary>
         string Id { get; }
 
         /// <summary>
-        /// Gets the number of comments in the issue or pull request.
+        /// Gets the number of comments in the pull request.
         /// </summary>
         int CommentCount { get; }
 
@@ -25,12 +24,7 @@ public interface IPullRequestListItemViewModel : IIssueListItemViewModelBase
         bool IsCurrent { get; }
 
         /// <summary>
-        /// Gets the labels applied to the issue or pull request.
-        /// </summary>
-        IReadOnlyList<ILabelViewModel> Labels { get; }
-
-        /// <summary>
-        /// Gets the last updated time of the issue or pull request.
+        /// Gets the last updated time of the pull request.
         /// </summary>
         DateTimeOffset UpdatedAt { get; }
     }

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

@@ -1,11 +1,16 @@
 using System;
-using System.Reactive;
 using ReactiveUI;
 
 namespace GitHub.ViewModels.GitHubPane
 {
+    /// <summary>
+    /// Represents a view model which displays a pull request list.
+    /// </summary>
     public interface IPullRequestListViewModel : IIssueListViewModelBase
     {
+        /// <summary>
+        /// Gets a command which navigates to the "Create Pull Request" view.
+        /// </summary>
         ReactiveCommand<object> CreatePullRequest { get; }
     }
 }