zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-05-29 17:32:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

modified XML docs

Browse Source
This commit is contained in:
aedampir@gmail.com
2016-06-15 17:51:25 +07:00
parent 27d0077aae
commit 554e2c1dc7
4 changed files with 34 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableIssueReactionsClient.cs
+8 -2
View File
@@ -2,6 +2,12 @@
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Reactions API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/reactions/">Reactions API documentation</a> for more information.
/// </remarks>
public interface IObservableIssueReactionsClient
{
/// <summary>
@@ -12,7 +18,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <param name="reaction">The reaction to create </param>
/// <returns></returns>
/// <returns>An <see cref="IObservable{T}"/> representing created <see cref="Reaction"/> for a specified issue.</returns>
IObservable<Reaction> Create(string owner, string name, int number, NewReaction reaction);
/// <summary>
@@ -22,7 +28,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <returns></returns>
/// <returns>An <see cref="IObservable{T}"/> representing <see cref="Reaction"/>s for a specified issue.</returns>
IObservable<Reaction> GetAll(string owner, string name, int number);
}
}
Octokit.Reactive/Clients/ObservableIssueReactionsClient.cs
+8 -2
View File
@@ -4,6 +4,12 @@ using System.Reactive.Threading.Tasks;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Reactions API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/reactions/">Reactions API documentation</a> for more information.
/// </remarks>
public class ObservableIssueReactionsClient : IObservableIssueReactionsClient
{
readonly IIssueReactionsClient _client;
@@ -25,7 +31,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <param name="reaction">The reaction to create</param>
/// <returns></returns>
/// <returns>An <see cref="IObservable{T}"/> representing created <see cref="Reaction"/> for a specified issue.</returns>
public IObservable<Reaction> Create(string owner, string name, int number, NewReaction reaction)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -42,7 +48,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <returns></returns>
/// <returns>An <see cref="IObservable{T}"/> representing <see cref="Reaction"/>s for a specified issue.</returns>
public IObservable<Reaction> GetAll(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Octokit/Clients/IIssueReactionsClient.cs
+8 -2
View File
@@ -3,6 +3,12 @@ using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Reactions API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/reactions/">Reactions API documentation</a> for more information.
/// </remarks>
public interface IIssueReactionsClient
{
/// <summary>
@@ -12,7 +18,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <returns></returns>
/// <returns>A <see cref="Task{T}"/> of <see cref="IReadOnlyList{T}"/> representing <see cref="Reaction"/>s for a specified issue.</returns>
Task<IReadOnlyList<Reaction>> GetAll(string owner, string name, int number);
/// <summary>
@@ -23,7 +29,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <param name="reaction">The reaction to create</param>
/// <returns></returns>
/// <returns>A <see cref="Task{Reaction}"/> representing created <see cref="Reaction"/> for a specified issue.</returns>
Task<Reaction> Create(string owner, string name, int number, NewReaction reaction);
}
}
Octokit/Clients/IssueReactionsClient.cs
+10 -5
View File
@@ -1,9 +1,14 @@
using System;
using System.Collections.Generic;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace Octokit
{
/// <summary>
/// A client for GitHub's Reactions API.
/// </summary>
/// <remarks>
/// See the <a href="https://developer.github.com/v3/reactions/">Reactions API documentation</a> for more information.
/// </remarks>
public class IssueReactionsClient : ApiClient, IIssueReactionsClient
{
public IssueReactionsClient(IApiConnection apiConnection)
@@ -14,12 +19,12 @@ namespace Octokit
/// <summary>
/// Creates a reaction for a specified Issue
/// </summary>
/// <remarks>https://developer.github.com/v3/reactions/#create-reactions-for-an-issue</remarks>
/// <remarks>https://developer.github.com/v3/reactions/#create-reaction-for-an-issue</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <param name="reaction">The reaction to create</param>
/// <returns></returns>
/// <returns>A <see cref="Task{Reaction}"/> representing created <see cref="Reaction"/> for a specified issue.</returns>
public Task<Reaction> Create(string owner, string name, int number, NewReaction reaction)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -36,7 +41,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue id</param>
/// <returns></returns>
/// <returns>A <see cref="Task{T}"/> of <see cref="IReadOnlyList{T}"/> representing <see cref="Reaction"/>s for a specified issue.</returns>
public Task<IReadOnlyList<Reaction>> GetAll(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");