diff --git a/Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs b/Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs
index 2cc9c479..9624cabf 100644
--- a/Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs
+++ b/Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs
@@ -3,6 +3,12 @@ using System.Diagnostics.CodeAnalysis;
namespace Octokit.Reactive
{
+ ///
+ /// A client for GitHub's Repository Commits API.
+ ///
+ ///
+ /// See the Repository Commits API documentation for more information.
+ ///
public interface IObservableRepositoryCommitsClient
{
///
@@ -12,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);
@@ -22,7 +28,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);
@@ -32,7 +38,7 @@ 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);
///
@@ -41,7 +47,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);
///
@@ -50,7 +56,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);
///
@@ -60,7 +66,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);
///
@@ -69,7 +75,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);
}
}
diff --git a/Octokit.Reactive/Clients/ObservableRepositoryCommitsClients.cs b/Octokit.Reactive/Clients/ObservableRepositoryCommitsClients.cs
index 3304e261..e852827b 100644
--- a/Octokit.Reactive/Clients/ObservableRepositoryCommitsClients.cs
+++ b/Octokit.Reactive/Clients/ObservableRepositoryCommitsClients.cs
@@ -4,6 +4,12 @@ using Octokit.Reactive.Internal;
namespace Octokit.Reactive
{
+ ///
+ /// A client for GitHub's Repository Commits API.
+ ///
+ ///
+ /// See the Repository Commits API documentation for more information.
+ ///
public class ObservableRepositoryCommitsClient : IObservableRepositoryCommitsClient
{
readonly IConnection _connection;
@@ -24,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)
{
return _commit.Compare(owner, name, @base, head).ToObservable();
@@ -36,7 +42,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");
@@ -51,7 +57,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");
@@ -66,7 +72,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");
@@ -82,7 +88,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");
@@ -99,7 +105,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");
@@ -115,7 +121,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");
diff --git a/Octokit/Clients/IRepositoryCommitsClient.cs b/Octokit/Clients/IRepositoryCommitsClient.cs
index 33c7b877..bb1f24dd 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 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);
@@ -39,7 +39,7 @@ 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);
///
@@ -48,7 +48,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);
///
@@ -57,7 +57,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);
///
@@ -67,15 +67,16 @@ 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);
+
///
/// Get the SHA-1 of a commit reference
///
/// 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);
}
}
diff --git a/Octokit/Clients/RepositoryCommitsClient.cs b/Octokit/Clients/RepositoryCommitsClient.cs
index 1e3a64e8..33afcebd 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 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");
@@ -55,7 +55,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");
@@ -70,7 +70,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");
@@ -78,14 +78,14 @@ namespace Octokit
return GetAll(owner, name, new CommitRequest(), options);
}
-
+
///
/// Gets all commits for a given repository
///
/// 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");
@@ -102,7 +102,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");
@@ -118,7 +118,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");