More comments

Author: StanleyGoldman

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

@@ -61,11 +61,11 @@ public sealed class PullRequestDetailViewModel : PanePageViewModelBase, IPullReq
         /// </summary>
         /// <param name="pullRequestsService">The pull requests service.</param>
         /// <param name="sessionManager">The pull request session manager.</param>
-        /// <param name="modelServiceFactory"></param>
+        /// <param name="modelServiceFactory">The model service factory</param>
         /// <param name="usageTracker">The usage tracker.</param>
         /// <param name="teamExplorerContext">The context for tracking repo changes</param>
-        /// <param name="files"></param>
-        /// <param name="syncSubmodulesCommand"></param>
+        /// <param name="files">The view model which will display the changed files</param>
+        /// <param name="syncSubmodulesCommand">A command that will be run when <see cref="SyncSubmodules"/> is executed</param>
         [ImportingConstructor]
         public PullRequestDetailViewModel(
             IPullRequestService pullRequestsService,

src/GitHub.Exports.Reactive/Services/IPullRequestService.cs

@@ -85,7 +85,7 @@ IObservable<IPullRequestModel> CreatePullRequest(IModelService modelService,
         /// Sync submodules on the current branch.
         /// </summary>
         /// <param name="repository">The repository.</param>
-        /// <param name="progress"></param>
+        /// <param name="progress">A method that will be called with progress messages</param>
         Task<bool> SyncSubmodules(ILocalRepositoryModel repository, Action<string> progress);
 
         /// <summary>

src/GitHub.Exports/Models/ILocalRepositoryModel.cs

@@ -29,7 +29,7 @@ public interface ILocalRepositoryModel : IRepositoryModel, INotifyPropertyChange
         /// Generates a http(s) url to the repository in the remote server, optionally
         /// pointing to a specific file and specific line range in it.
         /// </summary>
-        /// <param name="linkType"></param>
+        /// <param name="linkType">The type of repository link to create</param>
         /// <param name="path">The file to generate an url to. Optional.</param>
         /// <param name="startLine">A specific line, or (if specifying the <paramref name="endLine"/> as well) the start of a range</param>
         /// <param name="endLine">The end of a line range on the specified file.</param>

src/GitHub.InlineReviews/Commands/InlineCommentNavigationCommand.cs

@@ -75,7 +75,7 @@ protected int GetCursorPoint(ITextView textView, InlineCommentNavigationParams p
         /// <summary>
         /// Gets the text buffer position for the specified line.
         /// </summary>
-        /// <param name="textView"></param>
+        /// <param name="textView">The text view containing the buffer</param>
         /// <param name="lineNumber">The 0-based line number.</param>
         /// <returns></returns>
         protected int GetCursorPoint(ITextView textView, int lineNumber)
@@ -218,10 +218,10 @@ protected IReadOnlyList<ITagInfo> GetTags(IEnumerable<ITextView> textViews)
         /// <summary>
         /// Shows the inline comments for the specified tag in a peek view.
         /// </summary>
-        /// <param name="textView"></param>
-        /// <param name="tag"></param>
-        /// <param name="parameter"></param>
-        /// <param name="allTextViews"></param>
+        /// <param name="textView">The text view containing the tag</param>
+        /// <param name="tag">The inline comment tag</param>
+        /// <param name="parameter">The navigation parameter detailing a search from the specified tag</param>
+        /// <param name="allTextViews">The full list of text views</param>
         protected void ShowPeekComments(
             InlineCommentNavigationParams parameter,
             ITextView textView,

src/GitHub.InlineReviews/Models/InlineCommentThreadModel.cs

@@ -23,7 +23,7 @@ class InlineCommentThreadModel : ReactiveObject, IInlineCommentThreadModel
         /// <param name="diffMatch">
         /// The last five lines of the thread's diff hunk, in reverse order.
         /// </param>
-        /// <param name="comments"></param>
+        /// <param name="comments">The comments in the thread</param>
         public InlineCommentThreadModel(
             string relativePath,
             string commitSha,

src/GitHub.InlineReviews/Services/IInlineCommentPeekService.cs

@@ -15,7 +15,7 @@ public interface IInlineCommentPeekService
         /// Gets the line number for a peek session tracking point.
         /// </summary>
         /// <param name="session">The peek session.</param>
-        /// <param name="point"></param>
+        /// <param name="point">The peek session tracking point</param>
         /// <returns>
         /// A tuple containing the line number and whether the line number represents a line in the
         /// left hand side of a diff view.