From 554e2c1dc719c3cbc75351ef0ec0da2c2cf1137a Mon Sep 17 00:00:00 2001 From: "aedampir@gmail.com" Date: Wed, 15 Jun 2016 17:51:25 +0700 Subject: [PATCH] modified XML docs --- .../Clients/IObservableIssueReactionsClient.cs | 10 ++++++++-- .../Clients/ObservableIssueReactionsClient.cs | 10 ++++++++-- Octokit/Clients/IIssueReactionsClient.cs | 10 ++++++++-- Octokit/Clients/IssueReactionsClient.cs | 15 ++++++++++----- 4 files changed, 34 insertions(+), 11 deletions(-) diff --git a/Octokit.Reactive/Clients/IObservableIssueReactionsClient.cs b/Octokit.Reactive/Clients/IObservableIssueReactionsClient.cs index 3cfc109b..e87af5f9 100644 --- a/Octokit.Reactive/Clients/IObservableIssueReactionsClient.cs +++ b/Octokit.Reactive/Clients/IObservableIssueReactionsClient.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 IObservableIssueReactionsClient { /// @@ -12,7 +18,7 @@ namespace Octokit.Reactive /// The name of the repository /// The issue id /// The reaction to create - /// + /// An representing created for a specified issue. 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 issue id - /// + /// An representing s for a specified issue. IObservable GetAll(string owner, string name, int number); } } diff --git a/Octokit.Reactive/Clients/ObservableIssueReactionsClient.cs b/Octokit.Reactive/Clients/ObservableIssueReactionsClient.cs index 305e2408..e74a284f 100644 --- a/Octokit.Reactive/Clients/ObservableIssueReactionsClient.cs +++ b/Octokit.Reactive/Clients/ObservableIssueReactionsClient.cs @@ -4,6 +4,12 @@ using System.Reactive.Threading.Tasks; namespace Octokit.Reactive { + /// + /// A client for GitHub's Reactions API. + /// + /// + /// See the Reactions API documentation for more information. + /// public class ObservableIssueReactionsClient : IObservableIssueReactionsClient { readonly IIssueReactionsClient _client; @@ -25,7 +31,7 @@ namespace Octokit.Reactive /// The name of the repository /// The issue id /// The reaction to create - /// + /// An representing created for a specified issue. public IObservable Create(string owner, string name, int number, NewReaction reaction) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -42,7 +48,7 @@ namespace Octokit.Reactive /// The owner of the repository /// The name of the repository /// The issue id - /// + /// An representing s for a specified issue. public IObservable GetAll(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); diff --git a/Octokit/Clients/IIssueReactionsClient.cs b/Octokit/Clients/IIssueReactionsClient.cs index 478e0b2b..ca5fabf5 100644 --- a/Octokit/Clients/IIssueReactionsClient.cs +++ b/Octokit/Clients/IIssueReactionsClient.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 IIssueReactionsClient { /// @@ -12,7 +18,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue id - /// + /// A of representing s for a specified issue. Task> GetAll(string owner, string name, int number); /// @@ -23,7 +29,7 @@ namespace Octokit /// The name of the repository /// The issue id /// The reaction to create - /// + /// A representing created for a specified issue. Task Create(string owner, string name, int number, NewReaction reaction); } } diff --git a/Octokit/Clients/IssueReactionsClient.cs b/Octokit/Clients/IssueReactionsClient.cs index d630bfce..914ed77f 100644 --- a/Octokit/Clients/IssueReactionsClient.cs +++ b/Octokit/Clients/IssueReactionsClient.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 IssueReactionsClient : ApiClient, IIssueReactionsClient { public IssueReactionsClient(IApiConnection apiConnection) @@ -14,12 +19,12 @@ namespace Octokit /// /// Creates a reaction for a specified Issue /// - /// https://developer.github.com/v3/reactions/#create-reactions-for-an-issue + /// https://developer.github.com/v3/reactions/#create-reaction-for-an-issue /// The owner of the repository /// The name of the repository /// The issue id /// The reaction to create - /// + /// A representing created for a specified issue. 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 issue id - /// + /// A of representing s for a specified issue. public Task> GetAll(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner");