diff --git a/src/GitHub.Api/ILoginManager.cs b/src/GitHub.Api/ILoginManager.cs index 2736793025..d17408a6aa 100644 --- a/src/GitHub.Api/ILoginManager.cs +++ b/src/GitHub.Api/ILoginManager.cs @@ -72,6 +72,7 @@ Task LoginWithToken( /// Logs out of GitHub server. /// /// The address of the server. + /// An octokit client configured to access the server. Task Logout(HostAddress hostAddress, IGitHubClient client); } } \ No newline at end of file diff --git a/src/GitHub.Api/LoginManager.cs b/src/GitHub.Api/LoginManager.cs index 2920339633..7dcfbbda24 100644 --- a/src/GitHub.Api/LoginManager.cs +++ b/src/GitHub.Api/LoginManager.cs @@ -34,8 +34,10 @@ public class LoginManager : ILoginManager /// /// The keychain in which to store credentials. /// The handler for 2FA challenges. + /// The callback listener to signal successful login. /// The application's client API ID. /// The application's client API secret. + /// List of scopes to authenticate for /// An note to store with the authorization. /// The machine fingerprint. public LoginManager( diff --git a/src/GitHub.App/Extensions/AkavacheExtensions.cs b/src/GitHub.App/Extensions/AkavacheExtensions.cs index bbf59bed19..f1adcb1ef6 100644 --- a/src/GitHub.App/Extensions/AkavacheExtensions.cs +++ b/src/GitHub.App/Extensions/AkavacheExtensions.cs @@ -252,11 +252,12 @@ static IObservable GetAndFetchLatestFromIndex(this IBlobCache This, /// /// The cache to retrieve the object from. /// The key to look up the cache value with. - /// The item to add to the database + /// The fetch function. /// /// The maximum age of a cache object before the object is treated as /// expired and unusable. Cache objects older than this will be treated /// as a cache miss. + /// /// public static IObservable PutAndUpdateIndex(this IBlobCache blobCache, string key, diff --git a/src/GitHub.App/Services/PullRequestEditorService.cs b/src/GitHub.App/Services/PullRequestEditorService.cs index 27761e1cfe..9cf1b97222 100644 --- a/src/GitHub.App/Services/PullRequestEditorService.cs +++ b/src/GitHub.App/Services/PullRequestEditorService.cs @@ -336,6 +336,7 @@ public IVsTextView FindActiveView() /// The document we're navigating from. /// The document we're navigating to. /// The 0-based line we're navigating from. + /// /// The best matching line in public int FindMatchingLine(IList fromLines, IList toLines, int line, int matchLinesAbove = 0) { diff --git a/src/GitHub.App/ViewModels/GitHubPane/PullRequestDetailViewModel.cs b/src/GitHub.App/ViewModels/GitHubPane/PullRequestDetailViewModel.cs index 643d38ab6f..449e8393c8 100644 --- a/src/GitHub.App/ViewModels/GitHubPane/PullRequestDetailViewModel.cs +++ b/src/GitHub.App/ViewModels/GitHubPane/PullRequestDetailViewModel.cs @@ -61,12 +61,13 @@ public sealed class PullRequestDetailViewModel : PanePageViewModelBase, IPullReq /// /// Initializes a new instance of the class. /// - /// The local repository. - /// The model service. /// The pull requests service. /// The pull request session manager. + /// The model service factory /// The usage tracker. /// The context for tracking repo changes + /// The view model which will display the changed files + /// A command that will be run when is executed [ImportingConstructor] public PullRequestDetailViewModel( IPullRequestService pullRequestsService, @@ -200,6 +201,7 @@ public string TargetBranchDisplayName private set { this.RaiseAndSetIfChanged(ref targetBranchDisplayName, value); } } + /// /// Gets a value indicating whether the pull request branch is checked out. /// public bool IsCheckedOut diff --git a/src/GitHub.App/ViewModels/GitHubPane/PullRequestDirectoryNode.cs b/src/GitHub.App/ViewModels/GitHubPane/PullRequestDirectoryNode.cs index 6a9d46ebde..c270780ff8 100644 --- a/src/GitHub.App/ViewModels/GitHubPane/PullRequestDirectoryNode.cs +++ b/src/GitHub.App/ViewModels/GitHubPane/PullRequestDirectoryNode.cs @@ -12,7 +12,7 @@ public class PullRequestDirectoryNode : IPullRequestDirectoryNode /// /// Initializes a new instance of the class. /// - /// The path to the directory, relative to the repository. + /// The path to the directory, relative to the repository. public PullRequestDirectoryNode(string relativePath) { DirectoryName = System.IO.Path.GetFileName(relativePath); diff --git a/src/GitHub.Exports.Reactive/Services/IGitClient.cs b/src/GitHub.Exports.Reactive/Services/IGitClient.cs index eebd40c416..81fbbafebe 100644 --- a/src/GitHub.Exports.Reactive/Services/IGitClient.cs +++ b/src/GitHub.Exports.Reactive/Services/IGitClient.cs @@ -110,6 +110,7 @@ public interface IGitClient /// Task CompareWith(IRepository repository, string sha1, string sha2, string path, byte[] contents); + /// /// Gets the value of a configuration key. /// /// The repository. @@ -189,7 +190,7 @@ public interface IGitClient /// /// Find the merge base SHA between two commits. /// - /// The repository. + /// The repository. /// The clone url of the PR target repo. /// The PR base SHA. /// The PR head SHA. @@ -201,9 +202,10 @@ public interface IGitClient /// Thrown when the merge base can't be found. Task GetPullRequestMergeBase(IRepository repo, UriString targetCloneUrl, string baseSha, string headSha, string baseRef, int pullNumber); + /// /// Checks whether the current head is pushed to its remote tracking branch. /// - /// The repository. + /// The repository. /// Task IsHeadPushed(IRepository repo); @@ -212,7 +214,7 @@ public interface IGitClient /// and and returns their /// commit messages. /// - /// The repository. + /// The repository. /// The base branch to find a merge base with. /// The compare branch to find a merge base with. /// The maximum number of commits to return. diff --git a/src/GitHub.Exports.Reactive/Services/IPullRequestService.cs b/src/GitHub.Exports.Reactive/Services/IPullRequestService.cs index dd72963ac1..72ac6ec532 100644 --- a/src/GitHub.Exports.Reactive/Services/IPullRequestService.cs +++ b/src/GitHub.Exports.Reactive/Services/IPullRequestService.cs @@ -18,6 +18,7 @@ public interface IPullRequestService /// The repository owner. /// The repository name. /// The end cursor of the previous page, or null for the first page. + /// The pull request states to filter by /// A page of pull request item models. Task> ReadPullRequests( HostAddress address, @@ -84,6 +85,7 @@ IObservable CreatePullRequest(IModelService modelService, /// Sync submodules on the current branch. /// /// The repository. + /// A method that will be called with progress messages Task SyncSubmodules(ILocalRepositoryModel repository, Action progress); /// diff --git a/src/GitHub.Exports.Reactive/Services/IPullRequestSession.cs b/src/GitHub.Exports.Reactive/Services/IPullRequestSession.cs index 7c7b9ef045..dcc60b4d6e 100644 --- a/src/GitHub.Exports.Reactive/Services/IPullRequestSession.cs +++ b/src/GitHub.Exports.Reactive/Services/IPullRequestSession.cs @@ -153,6 +153,7 @@ Task PostReviewComment( /// /// Refreshes the pull request session. + /// /// A task which completes when the session has completed refreshing. Task Refresh(); } diff --git a/src/GitHub.Exports.Reactive/Services/IPullRequestSessionManager.cs b/src/GitHub.Exports.Reactive/Services/IPullRequestSessionManager.cs index de2ee24405..da9b407908 100644 --- a/src/GitHub.Exports.Reactive/Services/IPullRequestSessionManager.cs +++ b/src/GitHub.Exports.Reactive/Services/IPullRequestSessionManager.cs @@ -14,7 +14,7 @@ namespace GitHub.Services /// If the currently checked out branch represents a pull request then /// will return an containing the details of that pull request. /// A session for any other pull request can also be retrieved by calling - /// . + /// . /// /// Calling will return an /// which tracks both the contents of a text buffer and the diff --git a/src/GitHub.Exports.Reactive/Services/IRepositoryCloneService.cs b/src/GitHub.Exports.Reactive/Services/IRepositoryCloneService.cs index f3b7a8ec0c..0c35127851 100644 --- a/src/GitHub.Exports.Reactive/Services/IRepositoryCloneService.cs +++ b/src/GitHub.Exports.Reactive/Services/IRepositoryCloneService.cs @@ -23,7 +23,7 @@ public interface IRepositoryCloneService /// The directory that will contain the repository directory. /// /// An object through which to report progress. This must be of type - /// , but + /// System.IProgress<Microsoft.VisualStudio.Shell.ServiceProgressData>, but /// as that type is only available in VS2017+ it is typed as here. /// /// diff --git a/src/GitHub.Exports.Reactive/Services/IShowDialogService.cs b/src/GitHub.Exports.Reactive/Services/IShowDialogService.cs index e2c3a841f6..5f3a9bf332 100644 --- a/src/GitHub.Exports.Reactive/Services/IShowDialogService.cs +++ b/src/GitHub.Exports.Reactive/Services/IShowDialogService.cs @@ -35,6 +35,7 @@ public interface IShowDialogService /// The value returned by the 's /// observable, or null if the dialog was /// canceled. + /// /// /// The first existing connection will be used. If there is no existing connection, the /// login dialog will be shown first. diff --git a/src/GitHub.Exports/Factories/IViewViewModelFactory.cs b/src/GitHub.Exports/Factories/IViewViewModelFactory.cs index 70464d1943..e0db076839 100644 --- a/src/GitHub.Exports/Factories/IViewViewModelFactory.cs +++ b/src/GitHub.Exports/Factories/IViewViewModelFactory.cs @@ -13,7 +13,7 @@ public interface IViewViewModelFactory /// /// Creates a view model based on the specified interface type. /// - /// The view model interface type. + /// The view model interface type. /// The view model. TViewModel CreateViewModel() where TViewModel : IViewModel; diff --git a/src/GitHub.Exports/Models/ILocalRepositoryModel.cs b/src/GitHub.Exports/Models/ILocalRepositoryModel.cs index 0dc69f52ed..1295599b6a 100644 --- a/src/GitHub.Exports/Models/ILocalRepositoryModel.cs +++ b/src/GitHub.Exports/Models/ILocalRepositoryModel.cs @@ -29,6 +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. /// + /// The type of repository link to create /// The file to generate an url to. Optional. /// A specific line, or (if specifying the as well) the start of a range /// The end of a line range on the specified file. diff --git a/src/GitHub.Exports/Services/IGitHubContextService.cs b/src/GitHub.Exports/Services/IGitHubContextService.cs index b8522e93a1..8d8906233c 100644 --- a/src/GitHub.Exports/Services/IGitHubContextService.cs +++ b/src/GitHub.Exports/Services/IGitHubContextService.cs @@ -30,14 +30,14 @@ public interface IGitHubContextService /// /// Convert a context to a repository URL. /// - /// The context to convert. + /// A browser window title. /// A repository URL GitHubContext FindContextFromWindowTitle(string windowTitle); /// /// Find a context from a browser window title. /// - /// A browser window title. + /// /// The context or null if none can be found Uri ToRepositoryUrl(GitHubContext context); @@ -78,7 +78,7 @@ public interface IGitHubContextService /// Team Explorer creates temporary blob files in the following format: /// C:\Users\me\AppData\Local\Temp\TFSTemp\vctmp21996_181282.IOpenFromClipboardCommand.783ac965.cs /// The object-ish appears immediately before the file extension and the path contains the folder "TFSTemp". - /// + /// /// The path to a possible Team Explorer temporary blob file. /// The target file's object-ish (blob SHA fragment) or null if the path isn't recognized as a Team Explorer blob file. string FindObjectishForTFSTempFile(string tempFile); diff --git a/src/GitHub.Exports/Services/IGitService.cs b/src/GitHub.Exports/Services/IGitService.cs index 94bd216f32..b47987bb5b 100644 --- a/src/GitHub.Exports/Services/IGitService.cs +++ b/src/GitHub.Exports/Services/IGitService.cs @@ -12,6 +12,7 @@ public interface IGitService /// is null or no remote exists, this method returns null /// /// The repository to look at for the remote. + /// The remote name to look for /// A representing the origin or null if none found. UriString GetUri(IRepository repository, string remote = "origin"); @@ -24,6 +25,7 @@ public interface IGitService /// walks up the parent directories until it either finds a repository, or reaches the root disk. /// /// The path to start probing + /// The remote name to look for /// A representing the origin or null if none found. UriString GetUri(string path, string remote = "origin"); @@ -42,7 +44,8 @@ public interface IGitService /// /// Returns a representing the uri of a remote. /// - /// + /// The repository to look at for the remote. + /// The remote name to look for /// UriString GetRemoteUri(IRepository repo, string remote = "origin"); diff --git a/src/GitHub.Exports/Services/IVSGitServices.cs b/src/GitHub.Exports/Services/IVSGitServices.cs index ad56579d84..3795cd5974 100644 --- a/src/GitHub.Exports/Services/IVSGitServices.cs +++ b/src/GitHub.Exports/Services/IVSGitServices.cs @@ -17,9 +17,11 @@ public interface IVSGitServices /// Whether to recursively clone submodules. /// /// An object through which to report progress. This must be of type - /// , but + /// System.IProgress<Microsoft.VisualStudio.Shell.ServiceProgressData>, but /// as that type is only available in VS2017+ it is typed as here. /// + /// + /// Task Clone( string cloneUrl, string clonePath, diff --git a/src/GitHub.Exports/Services/IVSServices.cs b/src/GitHub.Exports/Services/IVSServices.cs index b532529084..d0171ada58 100644 --- a/src/GitHub.Exports/Services/IVSServices.cs +++ b/src/GitHub.Exports/Services/IVSServices.cs @@ -16,7 +16,7 @@ public interface IVSServices /// Our workaround is to create, open and delete a solution in the repo directory. /// This triggers an event that causes the target repo to open. ;) /// - /// The path to the repository to open + /// The path to the repository to open /// True if a transient solution was successfully created in target directory (which should trigger opening of repository). bool TryOpenRepository(string directory); diff --git a/src/GitHub.InlineReviews/Commands/InlineCommentNavigationCommand.cs b/src/GitHub.InlineReviews/Commands/InlineCommentNavigationCommand.cs index b0cd85ab8b..d86aeb9114 100644 --- a/src/GitHub.InlineReviews/Commands/InlineCommentNavigationCommand.cs +++ b/src/GitHub.InlineReviews/Commands/InlineCommentNavigationCommand.cs @@ -34,6 +34,7 @@ abstract class InlineCommentNavigationCommand : VsCommand /// Initializes a new instance of the class. /// + /// /// The tag aggregator factory. /// The peek service. /// The GUID of the group the command belongs to. @@ -74,7 +75,7 @@ protected int GetCursorPoint(ITextView textView, InlineCommentNavigationParams p /// /// Gets the text buffer position for the specified line. /// - /// The parameters. + /// The text view containing the buffer /// The 0-based line number. /// protected int GetCursorPoint(ITextView textView, int lineNumber) @@ -217,7 +218,10 @@ protected IReadOnlyList GetTags(IEnumerable textViews) /// /// Shows the inline comments for the specified tag in a peek view. /// - /// + /// The text view containing the tag + /// The inline comment tag + /// The navigation parameter detailing a search from the specified tag + /// The full list of text views protected void ShowPeekComments( InlineCommentNavigationParams parameter, ITextView textView, diff --git a/src/GitHub.InlineReviews/Models/InlineCommentThreadModel.cs b/src/GitHub.InlineReviews/Models/InlineCommentThreadModel.cs index 8ead806ddb..18fdf202b1 100644 --- a/src/GitHub.InlineReviews/Models/InlineCommentThreadModel.cs +++ b/src/GitHub.InlineReviews/Models/InlineCommentThreadModel.cs @@ -20,12 +20,10 @@ class InlineCommentThreadModel : ReactiveObject, IInlineCommentThreadModel /// /// The relative path to the file that the thread is on. /// The SHA of the commit that the thread appears on. - /// - /// The 1-based line number in the original diff that the thread was left on. - /// /// /// The last five lines of the thread's diff hunk, in reverse order. /// + /// The comments in the thread public InlineCommentThreadModel( string relativePath, string commitSha, diff --git a/src/GitHub.InlineReviews/Services/IDiffService.cs b/src/GitHub.InlineReviews/Services/IDiffService.cs index 58ce14b03a..c8c76aeeed 100644 --- a/src/GitHub.InlineReviews/Services/IDiffService.cs +++ b/src/GitHub.InlineReviews/Services/IDiffService.cs @@ -27,7 +27,7 @@ public interface IDiffService /// /// The repository /// The base commit SHA. - /// The head commit SHA.The head commit SHA. /// The path to the file in the repository. /// The byte array to compare with the base SHA. /// diff --git a/src/GitHub.InlineReviews/Services/IInlineCommentPeekService.cs b/src/GitHub.InlineReviews/Services/IInlineCommentPeekService.cs index 20b4fcee26..5351d64a2d 100644 --- a/src/GitHub.InlineReviews/Services/IInlineCommentPeekService.cs +++ b/src/GitHub.InlineReviews/Services/IInlineCommentPeekService.cs @@ -15,6 +15,7 @@ public interface IInlineCommentPeekService /// Gets the line number for a peek session tracking point. /// /// The peek session. + /// The peek session tracking point /// /// A tuple containing the line number and whether the line number represents a line in the /// left hand side of a diff view. diff --git a/src/GitHub.InlineReviews/Services/PullRequestSessionManager.cs b/src/GitHub.InlineReviews/Services/PullRequestSessionManager.cs index 63edf306a9..b0d69c0266 100644 --- a/src/GitHub.InlineReviews/Services/PullRequestSessionManager.cs +++ b/src/GitHub.InlineReviews/Services/PullRequestSessionManager.cs @@ -42,7 +42,7 @@ public class PullRequestSessionManager : ReactiveObject, IPullRequestSessionMana /// /// The PR service to use. /// The PR session service to use. - /// The team explorer service to use. + /// The team explorer context to use. [ImportingConstructor] public PullRequestSessionManager( IPullRequestService service, diff --git a/src/GitHub.InlineReviews/ViewModels/PullRequestReviewCommentViewModel.cs b/src/GitHub.InlineReviews/ViewModels/PullRequestReviewCommentViewModel.cs index f762ba3da9..047000f734 100644 --- a/src/GitHub.InlineReviews/ViewModels/PullRequestReviewCommentViewModel.cs +++ b/src/GitHub.InlineReviews/ViewModels/PullRequestReviewCommentViewModel.cs @@ -88,6 +88,7 @@ public PullRequestReviewCommentViewModel( /// Comment Service /// The thread that the comment is a part of. /// The current user. + /// The associated pull request review. /// The comment model. public PullRequestReviewCommentViewModel( IPullRequestSession session, diff --git a/src/GitHub.Services.Vssdk/Commands/MenuCommandServiceExtensions.cs b/src/GitHub.Services.Vssdk/Commands/MenuCommandServiceExtensions.cs index 5dcbefdcc7..f06dcc7d0f 100644 --- a/src/GitHub.Services.Vssdk/Commands/MenuCommandServiceExtensions.cs +++ b/src/GitHub.Services.Vssdk/Commands/MenuCommandServiceExtensions.cs @@ -16,7 +16,7 @@ public static class MenuCommandServiceExtensions /// Adds s or s to a menu. /// /// The menu command service. - /// The commands to add. + /// The commands to add. public static void AddCommands( this IMenuCommandService service, params IVsCommandBase[] commands) diff --git a/src/GitHub.TeamFoundation.14/Base/TeamExplorerServiceHolder.cs b/src/GitHub.TeamFoundation.14/Base/TeamExplorerServiceHolder.cs index af9d605b38..20879c8fbe 100644 --- a/src/GitHub.TeamFoundation.14/Base/TeamExplorerServiceHolder.cs +++ b/src/GitHub.TeamFoundation.14/Base/TeamExplorerServiceHolder.cs @@ -40,7 +40,7 @@ public class TeamExplorerServiceHolder : ITeamExplorerServiceHolder /// This constructor can be used for unit testing. /// /// Used for monitoring the active repository. - /// Used for switching to the Main thread. + /// Used for switching to the Main thread. public TeamExplorerServiceHolder(IVSGitExt gitService, JoinableTaskContext joinableTaskContext) { JoinableTaskCollection = joinableTaskContext.CreateCollection();