diff --git a/Octokit.Reactive/Clients/IObservableIssueCommentReactionsClient.cs b/Octokit.Reactive/Clients/IObservableIssueCommentReactionsClient.cs index 6ee2e35f..cf03d350 100644 --- a/Octokit.Reactive/Clients/IObservableIssueCommentReactionsClient.cs +++ b/Octokit.Reactive/Clients/IObservableIssueCommentReactionsClient.cs @@ -2,6 +2,12 @@ namespace Octokit.Reactive { + /// + /// A client for GitHub's Reactions API. + /// + /// + /// See the Reactions API documentation for more information. + /// public interface IObservableIssueCommentReactionsClient { /// @@ -12,7 +18,7 @@ namespace Octokit.Reactive /// The name of the repository /// The comment id /// The reaction to create - /// + /// A of < see cref="Reaction"/> representing created reaction for specified comment id. IObservable Create(string owner, string name, int number, NewReaction reaction); /// @@ -22,7 +28,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The comment id - /// + /// A of s representing reactions for specified comment id. IObservable GetAll(string owner, string name, int number); } } diff --git a/Octokit.Reactive/Clients/ObservableIssueCommentReactionsClient.cs b/Octokit.Reactive/Clients/ObservableIssueCommentReactionsClient.cs index 3bb42d9f..afcdf2e9 100644 --- a/Octokit.Reactive/Clients/ObservableIssueCommentReactionsClient.cs +++ b/Octokit.Reactive/Clients/ObservableIssueCommentReactionsClient.cs @@ -1,10 +1,15 @@ -using Octokit.Reactive.Internal; -using System; -using System.Reactive.Linq; +using System; using System.Reactive.Threading.Tasks; +using Octokit.Reactive.Internal; namespace Octokit.Reactive { + /// + /// A client for GitHub's Reactions API. + /// + /// + /// See the Reactions API documentation for more information. + /// public class ObservableIssueCommentReactionsClient : IObservableIssueCommentReactionsClient { readonly IIssueCommentReactionsClient _client; @@ -26,7 +31,7 @@ namespace Octokit.Reactive /// The name of the repository /// The comment id /// The reaction to create - /// + /// A of < see cref="Reaction"/> representing created reaction for specified comment id. public IObservable Create(string owner, string name, int number, NewReaction reaction) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -43,7 +48,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The comment id - /// + /// A of s representing reactions for specified comment id. public IObservable GetAll(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); diff --git a/Octokit/Clients/IIssueCommentReactionsClient.cs b/Octokit/Clients/IIssueCommentReactionsClient.cs index 6576201d..f2bd0e84 100644 --- a/Octokit/Clients/IIssueCommentReactionsClient.cs +++ b/Octokit/Clients/IIssueCommentReactionsClient.cs @@ -3,6 +3,12 @@ using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Reactions API. + /// + /// + /// See the Reactions API documentation for more information. + /// public interface IIssueCommentReactionsClient { /// @@ -13,7 +19,7 @@ namespace Octokit /// The name of the repository /// The comment id /// The reaction to create - /// + /// A representing created reaction for specified comment id. Task Create(string owner, string name, int number, NewReaction reaction); /// @@ -23,7 +29,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The comment id - /// + /// A of s representing reactions for specified comment id. Task> GetAll(string owner, string name, int number); } } diff --git a/Octokit/Clients/IssueCommentReactionsClient.cs b/Octokit/Clients/IssueCommentReactionsClient.cs index 352475d5..b351da89 100644 --- a/Octokit/Clients/IssueCommentReactionsClient.cs +++ b/Octokit/Clients/IssueCommentReactionsClient.cs @@ -1,9 +1,14 @@ -using System; -using System.Collections.Generic; +using System.Collections.Generic; using System.Threading.Tasks; namespace Octokit { + /// + /// A client for GitHub's Reactions API. + /// + /// + /// See the Reactions API documentation for more information. + /// public class IssueCommentReactionsClient : ApiClient, IIssueCommentReactionsClient { public IssueCommentReactionsClient(IApiConnection apiConnection) @@ -19,7 +24,7 @@ namespace Octokit /// The name of the repository /// The comment id /// The reaction to create - /// + /// A representing created reaction for specified comment id. public Task Create(string owner, string name, int number, NewReaction reaction) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -36,7 +41,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The comment id - /// + /// A of s representing reactions for specified comment id. public Task> GetAll(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner");