More code cleanup

StanleyGoldman · StanleyGoldman · commit 58e1797917df · 2018-09-11T09:52:26.000-04:00
diff --git a/src/GitHub.App/Services/PullRequestEditorService.cs b/src/GitHub.App/Services/PullRequestEditorService.cs
@@ -250,6 +250,7 @@ public Task<IDifferenceViewer> OpenDiff(
             return OpenDiff(session, relativePath, thread.CommitSha, thread.LineNumber - 1);
         }
 
+        /// <inheritdoc/>
         public async Task<IDifferenceViewer> OpenDiff(IPullRequestSession session, string relativePath, string headSha, int fromLine)
         {
             var diffViewer = await OpenDiff(session, relativePath, headSha, scrollToFirstDiff: false);
diff --git a/src/GitHub.App/ViewModels/GitHubPane/PullRequestAnnotationItemViewModel.cs b/src/GitHub.App/ViewModels/GitHubPane/PullRequestAnnotationItemViewModel.cs
@@ -22,7 +22,11 @@ public class PullRequestAnnotationItemViewModel : ViewModelBase, IPullRequestAnn
         /// <summary>
         /// Initializes the <see cref="PullRequestAnnotationItemViewModel"/>.
         /// </summary>
+        /// <param name="checkSuite">The check suite model.</param>
+        /// <param name="checkRun">The check run model.</param>
         /// <param name="annotation">The check run annotation model.</param>
+        /// <param name="session">The pull request session.</param>
+        /// <param name="editorService">The pull request editor service.</param>
         public PullRequestAnnotationItemViewModel(CheckSuiteModel checkSuite, 
             CheckRunModel checkRun,
             CheckRunAnnotationModel annotation,
@@ -43,6 +47,7 @@ public PullRequestAnnotationItemViewModel(CheckSuiteModel checkSuite,
             });
         }
 
+        /// <inheritdoc />
         public bool IsFileInPullRequest { get; }
 
         /// <inheritdoc />
@@ -51,6 +56,7 @@ public PullRequestAnnotationItemViewModel(CheckSuiteModel checkSuite,
         /// <inheritdoc />
         public string LineDescription => $"{Annotation.StartLine}:{Annotation.EndLine}";
 
+        /// <inheritdoc />
         public ReactiveCommand<Unit> OpenAnnotation { get; }
 
         /// <inheritdoc />
diff --git a/src/GitHub.App/ViewModels/GitHubPane/PullRequestAnnotationsViewModel.cs b/src/GitHub.App/ViewModels/GitHubPane/PullRequestAnnotationsViewModel.cs
@@ -27,6 +27,7 @@ public class PullRequestAnnotationsViewModel : PanePageViewModelBase, IPullReque
         /// Initializes a new instance of the <see cref="PullRequestAnnotationsViewModel"/> class.
         /// </summary>
         /// <param name="sessionManager">The pull request session manager.</param>
+        /// <param name="pullRequestEditorService">The pull request editor service.</param>
         [ImportingConstructor]
         public PullRequestAnnotationsViewModel(IPullRequestSessionManager sessionManager, IPullRequestEditorService pullRequestEditorService)
         {
diff --git a/src/GitHub.Exports.Reactive/Models/IInlineAnnotationModel.cs b/src/GitHub.Exports.Reactive/Models/IInlineAnnotationModel.cs
@@ -20,11 +20,34 @@ public interface IInlineAnnotationModel
         /// </summary>
         CheckAnnotationLevel AnnotationLevel { get; }
 
+        /// <summary>
+        /// Gets the annotation title.
+        /// </summary>
         string Title { get; }
+
+        /// <summary>
+        /// Gets the annotation message.
+        /// </summary>
         string Message { get; }
-        string FileName { get; }
+
+        /// <summary>
+        /// Gets the annotation path.
+        /// </summary>
+        string Path { get; }
+
+        /// <summary>
+        /// Gets the a descriptor for the line(s) reported.
+        /// </summary>
         string LineDescription { get; }
+
+        /// <summary>
+        /// Gets the name of the check run.
+        /// </summary>
         string CheckRunName { get; }
+
+        /// <summary>
+        /// Gets the sha the check run was created on.
+        /// </summary>
         string HeadSha { get; }
     }
 }
diff --git a/src/GitHub.Exports.Reactive/Models/InlineAnnotationModel.cs b/src/GitHub.Exports.Reactive/Models/InlineAnnotationModel.cs
@@ -26,7 +26,7 @@ public InlineAnnotationModel(CheckSuiteModel checkSuite, CheckRunModel checkRun,
             this.annotation = annotation;
         }
 
-        public string FileName => annotation.Path;
+        public string Path => annotation.Path;
 
         /// <inheritdoc />
         public int StartLine => annotation.StartLine;
@@ -37,16 +37,19 @@ public InlineAnnotationModel(CheckSuiteModel checkSuite, CheckRunModel checkRun,
         /// <inheritdoc />
         public CheckAnnotationLevel AnnotationLevel => annotation.AnnotationLevel;
 
+        /// <inheritdoc />
         public string CheckRunName => checkRun.Name;
 
+        /// <inheritdoc />
         public string Title => annotation.Title;
 
-        public CheckAnnotationLevel AnnotationLevel => annotation.AnnotationLevel.Value;
-
+        /// <inheritdoc />
         public string Message => annotation.Message;
 
+        /// <inheritdoc />
         public string HeadSha => checkSuite.HeadSha;
 
+        /// <inheritdoc />
         public string LineDescription => $"{StartLine}:{EndLine}";
     }
 }
diff --git a/src/GitHub.Exports.Reactive/ViewModels/GitHubPane/IPullRequestAnnotationItemViewModel.cs b/src/GitHub.Exports.Reactive/ViewModels/GitHubPane/IPullRequestAnnotationItemViewModel.cs
@@ -24,7 +24,14 @@ public interface IPullRequestAnnotationItemViewModel
         /// </summary>
         bool IsExpanded { get; set; }
 
+        /// <summary>
+        /// Gets a flag which indicates this annotation item is from a file changed in this pull request.
+        /// </summary>
         bool IsFileInPullRequest { get; }
+
+        /// <summary>
+        /// Gets a command which opens the annotation in the diff view.
+        /// </summary>
         ReactiveCommand<Unit> OpenAnnotation { get; }
     }
 }
diff --git a/src/GitHub.InlineReviews/Commands/NextInlineCommentCommand.cs b/src/GitHub.InlineReviews/Commands/NextInlineCommentCommand.cs
@@ -11,7 +11,7 @@
 namespace GitHub.InlineReviews.Commands
 {
     /// <summary>
-    /// Navigates to and opens the the next inline review in the currently active text view.
+    /// Navigates to and opens the the next inline comment thread in the currently active text view.
     /// </summary>
     [Export(typeof(INextInlineCommentCommand))]
     class NextInlineCommentCommand : InlineCommentNavigationCommand, INextInlineCommentCommand
diff --git a/src/GitHub.InlineReviews/Commands/PreviousInlineCommentCommand.cs b/src/GitHub.InlineReviews/Commands/PreviousInlineCommentCommand.cs
@@ -11,7 +11,7 @@
 namespace GitHub.InlineReviews.Commands
 {
     /// <summary>
-    /// Navigates to and opens the the previous inline review in the currently active text view.
+    /// Navigates to and opens the the previous inline comment thread in the currently active text view.
     /// </summary>
     [Export(typeof(IPreviousInlineCommentCommand))]
     class PreviousInlineCommentCommand : InlineCommentNavigationCommand, IPreviousInlineCommentCommand
diff --git a/src/GitHub.InlineReviews/Peek/InlineCommentPeekableItemSource.cs b/src/GitHub.InlineReviews/Peek/InlineCommentPeekableItemSource.cs
@@ -14,7 +14,7 @@ class InlineCommentPeekableItemSource : IPeekableItemSource
     {
         readonly IInlineCommentPeekService peekService;
         readonly IPullRequestSessionManager sessionManager;
-        readonly INextInlineCommentCommand _nextCommentCommand;
+        readonly INextInlineCommentCommand nextCommentCommand;
         readonly IPreviousInlineCommentCommand previousCommentCommand;
         readonly ICommentService commentService;
 
@@ -26,7 +26,7 @@ public InlineCommentPeekableItemSource(IInlineCommentPeekService peekService,
         {
             this.peekService = peekService;
             this.sessionManager = sessionManager;
-            this._nextCommentCommand = nextCommentCommand;
+            this.nextCommentCommand = nextCommentCommand;
             this.previousCommentCommand = previousCommentCommand;
             this.commentService = commentService;
         }
@@ -39,7 +39,7 @@ public void AugmentPeekSession(IPeekSession session, IList<IPeekableItem> peekab
                     peekService,
                     session,
                     sessionManager,
-                    _nextCommentCommand,
+                    nextCommentCommand,
                     previousCommentCommand,
                     commentService);
                 viewModel.Initialize().Forget();
diff --git a/src/GitHub.InlineReviews/Peek/InlineCommentPeekableItemSourceProvider.cs b/src/GitHub.InlineReviews/Peek/InlineCommentPeekableItemSourceProvider.cs
@@ -18,7 +18,7 @@ class InlineCommentPeekableItemSourceProvider : IPeekableItemSourceProvider
     {
         readonly IInlineCommentPeekService peekService;
         readonly IPullRequestSessionManager sessionManager;
-        readonly INextInlineCommentCommand _nextCommentCommand;
+        readonly INextInlineCommentCommand nextCommentCommand;
         readonly IPreviousInlineCommentCommand previousCommentCommand;
         readonly ICommentService commentService;
 
@@ -32,7 +32,7 @@ public InlineCommentPeekableItemSourceProvider(
         {
             this.peekService = peekService;
             this.sessionManager = sessionManager;
-            this._nextCommentCommand = nextCommentCommand;
+            this.nextCommentCommand = nextCommentCommand;
             this.previousCommentCommand = previousCommentCommand;
             this.commentService = commentService;
         }
@@ -42,7 +42,7 @@ public IPeekableItemSource TryCreatePeekableItemSource(ITextBuffer textBuffer)
             return new InlineCommentPeekableItemSource(
                 peekService,
                 sessionManager,
-                _nextCommentCommand,
+                nextCommentCommand,
                 previousCommentCommand,
                 commentService);
         }
diff --git a/src/GitHub.InlineReviews/Services/PullRequestSessionService.cs b/src/GitHub.InlineReviews/Services/PullRequestSessionService.cs
@@ -804,6 +804,7 @@ async Task<LastCommitAdapter> GetPullRequestLastCommitAdapter(HostAddress addres
                                                           Title = annotation.Title,
                                                           Message = annotation.Message,
                                                           Path = annotation.Path,
+                                                          AnnotationLevel = annotation.AnnotationLevel.Value.FromGraphQl(),
                                                           StartLine = annotation.Location.Start.Line,
                                                           EndLine = annotation.Location.End.Line,
                                                       }).ToList()
diff --git a/src/GitHub.InlineReviews/ViewModels/CommentThreadViewModel.cs b/src/GitHub.InlineReviews/ViewModels/CommentThreadViewModel.cs
@@ -22,10 +22,10 @@ public abstract class CommentThreadViewModel : ReactiveObject, ICommentThreadVie
         /// Intializes a new instance of the <see cref="CommentThreadViewModel"/> class.
         /// </summary>
         /// <param name="currentUser">The current user.</param>
-        /// <param name="annotationModels"></param>
-        protected CommentThreadViewModel(ActorModel currentUser, IReadOnlyList<InlineAnnotationViewModel> annotationModels)
+        /// <param name="annotations"></param>
+        protected CommentThreadViewModel(ActorModel currentUser, IReadOnlyList<InlineAnnotationViewModel> annotations)
         {
-            Annotations = annotationModels;
+            Annotations = annotations;
             Guard.ArgumentNotNull(currentUser, nameof(currentUser));
 
             Comments = new ObservableCollection<ICommentViewModel>();
@@ -77,6 +77,7 @@ protected set
         /// <inheritdoc/>
         public IActorViewModel CurrentUser { get; }
 
+        /// <inheritdoc/>
         public IReadOnlyList<IInlineAnnotationViewModel> Annotations { get; }
     }
 }
diff --git a/src/GitHub.InlineReviews/ViewModels/ICommentThreadViewModel.cs b/src/GitHub.InlineReviews/ViewModels/ICommentThreadViewModel.cs
@@ -38,6 +38,9 @@ public interface ICommentThreadViewModel
         /// </summary>
         ReactiveCommand<Unit> DeleteComment { get; }
 
+        /// <summary>
+        /// Gets the annotations displayed.
+        /// </summary>
         IReadOnlyList<IInlineAnnotationViewModel> Annotations { get; }
     }
 }
diff --git a/src/GitHub.InlineReviews/ViewModels/IInlineAnnotationViewModel.cs b/src/GitHub.InlineReviews/ViewModels/IInlineAnnotationViewModel.cs
@@ -2,8 +2,14 @@
 
 namespace GitHub.InlineReviews.ViewModels
 {
+    /// <summary>
+    /// A view model that represents a single inline annotation.
+    /// </summary>
     public interface IInlineAnnotationViewModel
     {
+        /// <summary>
+        /// Gets the inline annotation model.
+        /// </summary>
         IInlineAnnotationModel Model { get; }
     }
 }
diff --git a/src/GitHub.InlineReviews/ViewModels/InlineAnnotationViewModel.cs b/src/GitHub.InlineReviews/ViewModels/InlineAnnotationViewModel.cs
@@ -2,10 +2,16 @@
 
 namespace GitHub.InlineReviews.ViewModels
 {
+    /// <inheritdoc />
     public class InlineAnnotationViewModel: IInlineAnnotationViewModel
     {
+        /// <inheritdoc />
         public IInlineAnnotationModel Model { get; }
 
+        /// <summary>
+        /// Initializes a <see cref="InlineAnnotationViewModel"/>.
+        /// </summary>
+        /// <param name="model">The inline annotation model.</param>
         public InlineAnnotationViewModel(IInlineAnnotationModel model)
         {
             Model = model;
diff --git a/src/GitHub.InlineReviews/ViewModels/InlineCommentThreadViewModel.cs b/src/GitHub.InlineReviews/ViewModels/InlineCommentThreadViewModel.cs
@@ -21,12 +21,12 @@ public class InlineCommentThreadViewModel : CommentThreadViewModel
         /// </summary>
         /// <param name="commentService">The comment service</param>
         /// <param name="session">The current PR review session.</param>
-        /// <param name="annotationModels"></param>
+        /// <param name="annotations">The annotations to display in this inline review.</param>
         /// <param name="comments">The comments to display in this inline review.</param>
         public InlineCommentThreadViewModel(ICommentService commentService, IPullRequestSession session,
-            InlineAnnotationViewModel[] annotationModels,
+            InlineAnnotationViewModel[] annotations,
             IEnumerable<InlineCommentModel> comments)
-            : base(session.User, annotationModels)
+            : base(session.User, annotations)
         {
             Guard.ArgumentNotNull(session, nameof(session));
 
diff --git a/src/GitHub.InlineReviews/ViewModels/NewInlineCommentThreadViewModel.cs b/src/GitHub.InlineReviews/ViewModels/NewInlineCommentThreadViewModel.cs
@@ -23,19 +23,19 @@ public class NewInlineCommentThreadViewModel : CommentThreadViewModel
         /// </summary>
         /// <param name="commentService">The comment service</param>
         /// <param name="session">The current PR review session.</param>
-        /// <param name="annotationModels"></param>
+        /// <param name="annotations">The annotations to display in this inline review.</param>
         /// <param name="file">The file being commented on.</param>
         /// <param name="lineNumber">The 0-based line number in the file.</param>
         /// <param name="leftComparisonBuffer">
         ///     True if the comment is being left on the left-hand-side of a diff; otherwise false.
         /// </param>
         public NewInlineCommentThreadViewModel(ICommentService commentService,
             IPullRequestSession session,
-            InlineAnnotationViewModel[] annotationModels,
+            InlineAnnotationViewModel[] annotations,
             IPullRequestSessionFile file,
             int lineNumber,
             bool leftComparisonBuffer)
-            : base(session.User, annotationModels)
+            : base(session.User, annotations)
         {
             Guard.ArgumentNotNull(session, nameof(session));
             Guard.ArgumentNotNull(file, nameof(file));
diff --git a/src/GitHub.InlineReviews/Views/InlineAnnotationView.xaml b/src/GitHub.InlineReviews/Views/InlineAnnotationView.xaml
@@ -26,7 +26,7 @@
             <Run Text="{Binding Model.Title, Mode=OneWay}"/>
         </TextBlock>
         <TextBlock Margin="5 4 0 0">
-            <Run Text="{Binding Model.FileName, Mode=OneWay}"/>
+            <Run Text="{Binding Model.Path, Mode=OneWay}"/>
             <Run FontWeight="SemiBold" Text="{Binding Model.LineDescription, Mode=OneWay}"/>
         </TextBlock>
         <markdig:MarkdownViewer Margin="5 0 0 0" Markdown="{Binding Model.Message}"/>

Original file line number	Diff line number	Diff line change
`@@ -250,6 +250,7 @@ public Task<IDifferenceViewer> OpenDiff(`
`250`	`250`	`return OpenDiff(session, relativePath, thread.CommitSha, thread.LineNumber - 1);`
`251`	`251`	`}`
`252`	`252`
	`253`	`+ /// <inheritdoc/>`
`253`	`254`	`public async Task<IDifferenceViewer> OpenDiff(IPullRequestSession session, string relativePath, string headSha, int fromLine)`
`254`	`255`	`{`
`255`	`256`	`var diffViewer = await OpenDiff(session, relativePath, headSha, scrollToFirstDiff: false);`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ public class PullRequestAnnotationsViewModel : PanePageViewModelBase, IPullReque`
`27`	`27`	`/// Initializes a new instance of the <see cref="PullRequestAnnotationsViewModel"/> class.`
`28`	`28`	`/// </summary>`
`29`	`29`	`/// <param name="sessionManager">The pull request session manager.</param>`
	`30`	`+ /// <param name="pullRequestEditorService">The pull request editor service.</param>`
`30`	`31`	`[ImportingConstructor]`
`31`	`32`	`public PullRequestAnnotationsViewModel(IPullRequestSessionManager sessionManager, IPullRequestEditorService pullRequestEditorService)`
`32`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,14 @@ public interface IPullRequestAnnotationItemViewModel`
`24`	`24`	`/// </summary>`
`25`	`25`	`bool IsExpanded { get; set; }`
`26`	`26`
	`27`	`+ /// <summary>`
	`28`	`+ /// Gets a flag which indicates this annotation item is from a file changed in this pull request.`
	`29`	`+ /// </summary>`
`27`	`30`	`bool IsFileInPullRequest { get; }`
	`31`	`+`
	`32`	`+ /// <summary>`
	`33`	`+ /// Gets a command which opens the annotation in the diff view.`
	`34`	`+ /// </summary>`
`28`	`35`	`ReactiveCommand<Unit> OpenAnnotation { get; }`
`29`	`36`	`}`
`30`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`namespace GitHub.InlineReviews.Commands`
`12`	`12`	`{`
`13`	`13`	`/// <summary>`
`14`		`- /// Navigates to and opens the the next inline review in the currently active text view.`
	`14`	`+ /// Navigates to and opens the the next inline comment thread in the currently active text view.`
`15`	`15`	`/// </summary>`
`16`	`16`	`[Export(typeof(INextInlineCommentCommand))]`
`17`	`17`	`class NextInlineCommentCommand : InlineCommentNavigationCommand, INextInlineCommentCommand`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class InlineCommentPeekableItemSourceProvider : IPeekableItemSourceProvider`
`18`	`18`	`{`
`19`	`19`	`readonly IInlineCommentPeekService peekService;`
`20`	`20`	`readonly IPullRequestSessionManager sessionManager;`
`21`		`- readonly INextInlineCommentCommand _nextCommentCommand;`
	`21`	`+ readonly INextInlineCommentCommand nextCommentCommand;`
`22`	`22`	`readonly IPreviousInlineCommentCommand previousCommentCommand;`
`23`	`23`	`readonly ICommentService commentService;`
`24`	`24`
`@@ -32,7 +32,7 @@ public InlineCommentPeekableItemSourceProvider(`
`32`	`32`	`{`
`33`	`33`	`this.peekService = peekService;`
`34`	`34`	`this.sessionManager = sessionManager;`
`35`		`- this._nextCommentCommand = nextCommentCommand;`
	`35`	`+ this.nextCommentCommand = nextCommentCommand;`
`36`	`36`	`this.previousCommentCommand = previousCommentCommand;`
`37`	`37`	`this.commentService = commentService;`
`38`	`38`	`}`
`@@ -42,7 +42,7 @@ public IPeekableItemSource TryCreatePeekableItemSource(ITextBuffer textBuffer)`
`42`	`42`	`return new InlineCommentPeekableItemSource(`
`43`	`43`	`peekService,`
`44`	`44`	`sessionManager,`
`45`		`- _nextCommentCommand,`
	`45`	`+ nextCommentCommand,`
`46`	`46`	`previousCommentCommand,`
`47`	`47`	`commentService);`
`48`	`48`	`}`