Repairing xml comments #1846
Repairing xml comments #1846
Conversation
StanleyGoldman
force-pushed
the
xml-doc-comments
branch
from
f578e14 to
2cf8ff9
Compare
| /// <param name="modelService">The model service.</param> | ||
| /// <param name="pullRequestsService">The pull requests service.</param> | ||
| /// <param name="sessionManager">The pull request session manager.</param> | ||
| /// <param name="modelServiceFactory"></param> |
There was a problem hiding this comment.
I think simply "The model service factory" would suffice here.
| /// <param name="modelServiceFactory"></param> | ||
| /// <param name="usageTracker">The usage tracker.</param> | ||
| /// <param name="teamExplorerContext">The context for tracking repo changes</param> | ||
| /// <param name="files"></param> |
There was a problem hiding this comment.
The view model which will display the changed files
| /// <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> |
There was a problem hiding this comment.
A command that will be run when <see cref="SyncSubmodules"/> is executed
| /// Sync submodules on the current branch. | ||
| /// </summary> | ||
| /// <param name="repository">The repository.</param> | ||
| /// <param name="progress"></param> |
There was a problem hiding this comment.
A method that will be called with progress messages
| /// 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> |
There was a problem hiding this comment.
The type of repository link to create
| /// Shows the inline comments for the specified tag in a peek view. | ||
| /// </summary> | ||
| /// <param name="textView"></param> | ||
| /// <param name="tag"></param> |
| /// </summary> | ||
| /// <param name="textView"></param> | ||
| /// <param name="tag"></param> | ||
| /// <param name="parameter"></param> |
There was a problem hiding this comment.
Hmm, this one is difficult
The navigation parameter detailing a search from the specified tag
Or something?!
| /// <param name="textView"></param> | ||
| /// <param name="tag"></param> | ||
| /// <param name="parameter"></param> | ||
| /// <param name="allTextViews"></param> |
There was a problem hiding this comment.
The additional text views when showing a comment in a diff view or something?
There was a problem hiding this comment.
The full list of text views
| /// <param name="diffMatch"> | ||
| /// The last five lines of the thread's diff hunk, in reverse order. | ||
| /// </param> | ||
| /// <param name="comments"></param> |
| /// Gets the line number for a peek session tracking point. | ||
| /// </summary> | ||
| /// <param name="session">The peek session.</param> | ||
| /// <param name="point"></param> |
There was a problem hiding this comment.
The peek session tracking point
StanleyGoldman
force-pushed
the
xml-doc-comments
branch
from
2023cc8 to
ff7be2a
Compare
StanleyGoldman
force-pushed
the
xml-doc-comments
branch
from
ff7be2a to
72fd428
Compare
StanleyGoldman
left a comment
StanleyGoldman
left a comment
There was a problem hiding this comment.
Going back in time
StanleyGoldman
left a comment
StanleyGoldman
left a comment
There was a problem hiding this comment.
Great Scott Marty! To the DeLorean!
StanleyGoldman
left a comment
StanleyGoldman
left a comment
There was a problem hiding this comment.
I'm gonna be mayor of this town
StanleyGoldman
left a comment
StanleyGoldman
left a comment
There was a problem hiding this comment.
I'm gonna be mayor of this town
StanleyGoldman
left a comment
StanleyGoldman
left a comment
There was a problem hiding this comment.
I'm gonna be mayor of this town
StanleyGoldman
left a comment
StanleyGoldman
left a comment
There was a problem hiding this comment.
I'm gonna be mayor of this town
StanleyGoldman
left a comment
StanleyGoldman
left a comment
There was a problem hiding this comment.
I'm gonna be mayor of this town
StanleyGoldman
left a comment
StanleyGoldman
left a comment
There was a problem hiding this comment.
Someday I'm gonna be mayor of this town
| /// <param name="progress"> | ||
| /// An object through which to report progress. This must be of type | ||
| /// <see cref="System.IProgress{Microsoft.VisualStudio.Shell.ServiceProgressData}"/>, but | ||
| /// System.IProgress<Microsoft.VisualStudio.Shell.ServiceProgressData>, but |
There was a problem hiding this comment.
It was an incorrect <see> tag. The "cref" value could provide a link to documentation for System.IProgress{T} or Microsoft.VisualStudio.Shell.ServiceProgressData, but there is no link to documentation for System.IProgress{Microsoft.VisualStudio.Shell.ServiceProgressData}.
| /// <param name="blobCache">The cache to retrieve the object from.</param> | ||
| /// <param name="key">The key to look up the cache value with.</param> | ||
| /// <param name="item">The item to add to the database</param> | ||
| /// <param name="fetchFunc"></param> |
There was a problem hiding this comment.
The fetch function - this is what the other params like like in the same file are documented with.
| /// <param name="fromLines">The document we're navigating from.</param> | ||
| /// <param name="toLines">The document we're navigating to.</param> | ||
| /// <param name="line">The 0-based line we're navigating from.</param> | ||
| /// <param name="matchLinesAbove"></param> |
There was a problem hiding this comment.
The number of lines to match.
There was a problem hiding this comment.
@jcansdale shouldn't the default for this parameter be MatchLinesAboveTarget instead of 0?
| /// Find a context from a browser window title. | ||
| /// </summary> | ||
| /// <param name="windowTitle">A browser window title.</param> | ||
| /// <param name="context"></param> |
There was a problem hiding this comment.
The context? Not very descriptive. Do we need more info than this? @jcansdale?
| /// <param name="commentService">Comment Service</param> | ||
| /// <param name="thread">The thread that the comment is a part of.</param> | ||
| /// <param name="currentUser">The current user.</param> | ||
| /// <param name="review"></param> |
There was a problem hiding this comment.
The associated pull request review.
Cleaning up xml comments