diff --git a/Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs b/Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs index 4b6f0a6d..68af9746 100644 --- a/Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs +++ b/Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs @@ -18,7 +18,7 @@ namespace Octokit.Reactive /// The name of the repository /// The reference to use as the base commit /// The reference to use as the head commit - /// A of for the specified references. + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")] IObservable Compare(string owner, string name, string @base, string head); @@ -28,7 +28,7 @@ namespace Octokit.Reactive /// The ID of the repository /// The reference to use as the base commit /// The reference to use as the head commit - /// A of for the specified references. + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")] IObservable Compare(int repositoryId, string @base, string head); @@ -38,7 +38,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The reference for the commit - /// A of for the specified commit SHA. + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] IObservable Get(string owner, string name, string reference); @@ -48,7 +48,7 @@ namespace Octokit.Reactive /// /// The ID of the repository /// The reference for the commit - /// A of for the specified commit SHA. + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] IObservable Get(int repositoryId, string reference); @@ -58,14 +58,14 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// A of s for the specified repository. + /// IObservable GetAll(string owner, string name); /// /// Gets all commits for a given repository /// /// The ID of the repository - /// A of s for the specified repository. + /// IObservable GetAll(int repositoryId); /// @@ -74,7 +74,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// Options for changing the API response - /// A of s for the specified repository. + /// IObservable GetAll(string owner, string name, ApiOptions options); /// @@ -82,7 +82,7 @@ namespace Octokit.Reactive /// /// The ID of the repository /// Options for changing the API response - /// A of s for the specified repository. + /// IObservable GetAll(int repositoryId, ApiOptions options); /// @@ -91,7 +91,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// Used to filter list of commits returned - /// A of s for the specified repository. + /// IObservable GetAll(string owner, string name, CommitRequest request); /// @@ -99,7 +99,7 @@ namespace Octokit.Reactive /// /// The ID of the repository /// Used to filter list of commits returned - /// A of s for the specified repository. + /// IObservable GetAll(int repositoryId, CommitRequest request); /// @@ -109,7 +109,7 @@ namespace Octokit.Reactive /// The name of the repository /// Used to filter list of commits returned /// Options for changing the API response - /// A of s for the specified repository. + /// IObservable GetAll(string owner, string name, CommitRequest request, ApiOptions options); /// @@ -118,7 +118,7 @@ namespace Octokit.Reactive /// The ID of the repository /// Used to filter list of commits returned /// Options for changing the API response - /// A of s for the specified repository. + /// IObservable GetAll(int repositoryId, CommitRequest request, ApiOptions options); /// @@ -127,7 +127,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The repository reference - /// A of for the specified repository reference. + /// IObservable GetSha1(string owner, string name, string reference); /// @@ -135,7 +135,7 @@ namespace Octokit.Reactive /// /// The ID of the repository /// The repository reference - /// A of for the specified repository reference. + /// IObservable GetSha1(int repositoryId, string reference); } } diff --git a/Octokit.Reactive/Clients/ObservableRepositoryCommitsClients.cs b/Octokit.Reactive/Clients/ObservableRepositoryCommitsClients.cs index 977a07f5..9732da66 100644 --- a/Octokit.Reactive/Clients/ObservableRepositoryCommitsClients.cs +++ b/Octokit.Reactive/Clients/ObservableRepositoryCommitsClients.cs @@ -30,7 +30,7 @@ namespace Octokit.Reactive /// The name of the repository /// The reference to use as the base commit /// The reference to use as the head commit - /// A of for the specified references. + /// public IObservable Compare(string owner, string name, string @base, string head) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -47,7 +47,7 @@ namespace Octokit.Reactive /// The ID of the repository /// The reference to use as the base commit /// The reference to use as the head commit - /// A of for the specified references. + /// public IObservable Compare(int repositoryId, string @base, string head) { Ensure.ArgumentNotNullOrEmptyString(@base, "base"); @@ -62,7 +62,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The reference for the commit - /// A of for the specified commit SHA. + /// public IObservable Get(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -77,7 +77,7 @@ namespace Octokit.Reactive /// /// The ID of the repository /// The reference for the commit - /// A of for the specified commit SHA. + /// public IObservable Get(int repositoryId, string reference) { Ensure.ArgumentNotNullOrEmptyString(reference, "reference"); @@ -90,7 +90,7 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// A of s for the specified repository. + /// public IObservable GetAll(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -103,7 +103,7 @@ namespace Octokit.Reactive /// Gets all commits for a given repository /// /// The ID of the repository - /// A of s for the specified repository. + /// public IObservable GetAll(int repositoryId) { return GetAll(repositoryId, new CommitRequest(), ApiOptions.None); @@ -115,7 +115,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// Options for changing the API response - /// A of s for the specified repository. + /// public IObservable GetAll(string owner, string name, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -130,7 +130,7 @@ namespace Octokit.Reactive /// /// The ID of the repository /// Options for changing the API response - /// A of s for the specified repository. + /// public IObservable GetAll(int repositoryId, ApiOptions options) { Ensure.ArgumentNotNull(options, "options"); @@ -144,7 +144,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// Used to filter list of commits returned - /// A of s for the specified repository. + /// public IObservable GetAll(string owner, string name, CommitRequest request) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -159,7 +159,7 @@ namespace Octokit.Reactive /// /// The ID of the repository /// Used to filter list of commits returned - /// A of s for the specified repository. + /// public IObservable GetAll(int repositoryId, CommitRequest request) { Ensure.ArgumentNotNull(request, "request"); @@ -174,7 +174,7 @@ namespace Octokit.Reactive /// The name of the repository /// Used to filter list of commits returned /// Options for changing the API response - /// A of s for the specified repository. + /// public IObservable GetAll(string owner, string name, CommitRequest request, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -191,7 +191,7 @@ namespace Octokit.Reactive /// The ID of the repository /// Used to filter list of commits returned /// Options for changing the API response - /// A of s for the specified repository. + /// public IObservable GetAll(int repositoryId, CommitRequest request, ApiOptions options) { Ensure.ArgumentNotNull(request, "request"); @@ -206,7 +206,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The repository reference - /// A of for the specified repository reference. + /// public IObservable GetSha1(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -221,7 +221,7 @@ namespace Octokit.Reactive /// /// The ID of the repository /// The repository reference - /// A of for the specified repository reference. + /// public IObservable GetSha1(int repositoryId, string reference) { Ensure.ArgumentNotNullOrEmptyString(reference, "reference"); diff --git a/Octokit/Clients/IRepositoryCommitsClient.cs b/Octokit/Clients/IRepositoryCommitsClient.cs index 3ac895f2..9b6b9006 100644 --- a/Octokit/Clients/IRepositoryCommitsClient.cs +++ b/Octokit/Clients/IRepositoryCommitsClient.cs @@ -19,7 +19,7 @@ namespace Octokit /// The name of the repository /// The reference to use as the base commit /// The reference to use as the head commit - /// A for the specified references. + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")] Task Compare(string owner, string name, string @base, string head); @@ -29,7 +29,7 @@ namespace Octokit /// The ID of the repository /// The reference to use as the base commit /// The reference to use as the head commit - /// A for the specified references. + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "base")] Task Compare(int repositoryId, string @base, string head); @@ -39,7 +39,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The reference for the commit (SHA) - /// A for the specified commit SHA. + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Makes a network request")] Task Get(string owner, string name, string reference); @@ -49,7 +49,7 @@ namespace Octokit /// /// The ID of the repository /// The reference for the commit (SHA) - /// A for the specified commit SHA. + /// [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Makes a network request")] Task Get(int repositoryId, string reference); @@ -59,14 +59,14 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// A of s for the specified repository. + /// Task> GetAll(string owner, string name); /// /// Gets all commits for a given repository /// /// The ID of the repository - /// A of s for the specified repository. + /// Task> GetAll(int repositoryId); /// @@ -75,7 +75,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Options for changing the API response - /// A of s for the specified repository. + /// Task> GetAll(string owner, string name, ApiOptions options); /// @@ -83,7 +83,7 @@ namespace Octokit /// /// The ID of the repository /// Options for changing the API response - /// A of s for the specified repository. + /// Task> GetAll(int repositoryId, ApiOptions options); /// @@ -92,7 +92,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Used to filter list of commits returned - /// A of s for the specified repository. + /// Task> GetAll(string owner, string name, CommitRequest request); /// @@ -100,7 +100,7 @@ namespace Octokit /// /// The ID of the repository /// Used to filter list of commits returned - /// A of s for the specified repository. + /// Task> GetAll(int repositoryId, CommitRequest request); /// @@ -110,7 +110,7 @@ namespace Octokit /// The name of the repository /// Used to filter list of commits returned /// Options for changing the API response - /// A of s for the specified repository. + /// Task> GetAll(string owner, string name, CommitRequest request, ApiOptions options); /// @@ -119,7 +119,7 @@ namespace Octokit /// The ID of the repository /// Used to filter list of commits returned /// Options for changing the API response - /// A of s for the specified repository. + /// Task> GetAll(int repositoryId, CommitRequest request, ApiOptions options); /// @@ -128,7 +128,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The repository reference - /// A for the specified repository reference. + /// Task GetSha1(string owner, string name, string reference); /// @@ -136,7 +136,7 @@ namespace Octokit /// /// The ID of the repository /// The repository reference - /// A for the specified repository reference. + /// Task GetSha1(int repositoryId, string reference); } } diff --git a/Octokit/Clients/RepositoryCommitsClient.cs b/Octokit/Clients/RepositoryCommitsClient.cs index 3af33bd2..01c8d7ca 100644 --- a/Octokit/Clients/RepositoryCommitsClient.cs +++ b/Octokit/Clients/RepositoryCommitsClient.cs @@ -23,7 +23,7 @@ namespace Octokit /// The name of the repository /// The reference to use as the base commit /// The reference to use as the head commit - /// A for the specified references. + /// public Task Compare(string owner, string name, string @base, string head) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -40,7 +40,7 @@ namespace Octokit /// The ID of the repository /// The reference to use as the base commit /// The reference to use as the head commit - /// A for the specified references. + /// public Task Compare(int repositoryId, string @base, string head) { Ensure.ArgumentNotNullOrEmptyString(@base, "base"); @@ -55,7 +55,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The reference for the commit (SHA) - /// A for the specified commit SHA. + /// public Task Get(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -70,7 +70,7 @@ namespace Octokit /// /// The ID of the repository /// The reference for the commit (SHA) - /// A for the specified commit SHA. + /// public Task Get(int repositoryId, string reference) { Ensure.ArgumentNotNullOrEmptyString(reference, "reference"); @@ -83,7 +83,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// A of s for the specified repository. + /// public Task> GetAll(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -96,7 +96,7 @@ namespace Octokit /// Gets all commits for a given repository /// /// The ID of the repository - /// A of s for the specified repository. + /// public Task> GetAll(int repositoryId) { return GetAll(repositoryId, new CommitRequest(), ApiOptions.None); @@ -108,7 +108,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Options for changing the API response - /// A of s for the specified repository. + /// public Task> GetAll(string owner, string name, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -122,7 +122,7 @@ namespace Octokit /// /// The ID of the repository /// Options for changing the API response - /// A of s for the specified repository. + /// public Task> GetAll(int repositoryId, ApiOptions options) { return GetAll(repositoryId, new CommitRequest(), options); @@ -134,7 +134,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Used to filter list of commits returned - /// A of s for the specified repository. + /// public Task> GetAll(string owner, string name, CommitRequest request) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -149,7 +149,7 @@ namespace Octokit /// /// The ID of the repository /// Used to filter list of commits returned - /// A of s for the specified repository. + /// public Task> GetAll(int repositoryId, CommitRequest request) { Ensure.ArgumentNotNull(request, "request"); @@ -164,7 +164,7 @@ namespace Octokit /// The name of the repository /// Used to filter list of commits returned /// Options for changing the API response - /// A of s for the specified repository. + /// public Task> GetAll(string owner, string name, CommitRequest request, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -181,7 +181,7 @@ namespace Octokit /// The ID of the repository /// Used to filter list of commits returned /// Options for changing the API response - /// A of s for the specified repository. + /// public Task> GetAll(int repositoryId, CommitRequest request, ApiOptions options) { Ensure.ArgumentNotNull(request, "request"); @@ -196,7 +196,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The repository reference - /// A for the specified repository reference. + /// public Task GetSha1(string owner, string name, string reference) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -211,7 +211,7 @@ namespace Octokit /// /// The ID of the repository /// The repository reference - /// A for the specified repository reference. + /// public Task GetSha1(int repositoryId, string reference) { Ensure.ArgumentNotNullOrEmptyString(reference, "reference");