diff --git a/Octokit.Reactive/Clients/IObservableAssigneesClient.cs b/Octokit.Reactive/Clients/IObservableAssigneesClient.cs index b47ad18e..4e93269b 100644 --- a/Octokit.Reactive/Clients/IObservableAssigneesClient.cs +++ b/Octokit.Reactive/Clients/IObservableAssigneesClient.cs @@ -2,6 +2,12 @@ namespace Octokit.Reactive { + /// + /// A client for GitHub's Issue Assignees API. + /// + /// + /// See the Issue Assignees API documentation for more information. + /// public interface IObservableAssigneesClient { /// @@ -9,7 +15,7 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// + /// A of representing assignees of specified repository. IObservable GetAllForRepository(string owner, string name); /// @@ -18,7 +24,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The options to change API's behaviour. - /// + /// A of representing assignees of specified repository. IObservable GetAllForRepository(string owner, string name, ApiOptions options); /// @@ -27,7 +33,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// Username of the prospective assignee - /// + /// A of representing is a user is an assignee for a repository. IObservable CheckAssignee(string owner, string name, string assignee); } } diff --git a/Octokit.Reactive/Clients/ObservableAssigneesClient.cs b/Octokit.Reactive/Clients/ObservableAssigneesClient.cs index de7eb9c9..e243c9a1 100644 --- a/Octokit.Reactive/Clients/ObservableAssigneesClient.cs +++ b/Octokit.Reactive/Clients/ObservableAssigneesClient.cs @@ -4,6 +4,12 @@ using Octokit.Reactive.Internal; namespace Octokit.Reactive { + /// + /// A client for GitHub's Issue Assignees API. + /// + /// + /// See the Issue Assignees API documentation for more information. + /// public class ObservableAssigneesClient : IObservableAssigneesClient { readonly IAssigneesClient _client; @@ -22,7 +28,7 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// + /// A of representing assignees of specified repository. public IObservable GetAllForRepository(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -36,8 +42,8 @@ namespace Octokit.Reactive /// /// The owner of the repository /// The name of the repository - /// The options to change API's behaviour - /// + /// The options to change API's behaviour. + /// A of representing assignees of specified repository. public IObservable GetAllForRepository(string owner, string name, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -53,7 +59,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// Username of the prospective assignee - /// + /// A of representing is a user is an assignee for a repository. public IObservable CheckAssignee(string owner, string name, string assignee) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); diff --git a/Octokit/Clients/AssigneesClient.cs b/Octokit/Clients/AssigneesClient.cs index 0cd692c7..70fafd39 100644 --- a/Octokit/Clients/AssigneesClient.cs +++ b/Octokit/Clients/AssigneesClient.cs @@ -24,7 +24,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// + /// A of representing assignees of specified repository. public Task> GetAllForRepository(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -39,7 +39,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The options to change API's response. - /// + /// A of representing assignees of specified repository. public Task> GetAllForRepository(string owner, string name, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -57,7 +57,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Username of the prospective assignee - /// + /// A representing is a user is an assignee for a repository. public async Task CheckAssignee(string owner, string name, string assignee) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); diff --git a/Octokit/Clients/IAssigneesClient.cs b/Octokit/Clients/IAssigneesClient.cs index 77d04912..9aba338d 100644 --- a/Octokit/Clients/IAssigneesClient.cs +++ b/Octokit/Clients/IAssigneesClient.cs @@ -16,7 +16,7 @@ namespace Octokit /// /// The owner of the repository /// The name of the repository - /// + /// A of representing assignees of specified repository. Task> GetAllForRepository(string owner, string name); /// @@ -25,7 +25,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The options to change API's response. - /// + /// A of representing assignees of specified repository. Task> GetAllForRepository(string owner, string name, ApiOptions options); /// @@ -34,7 +34,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Username of the prospective assignee - /// + /// A representing is a user is an assignee for a repository. Task CheckAssignee(string owner, string name, string assignee); } }