mirror of
https://github.com/zoriya/octokit.net.git
synced 2026-06-01 18:35:35 +00:00
modified XML docs
reordered usings
This commit is contained in:
@@ -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 IObservableIssueCommentReactionsClient
|
||||
{
|
||||
/// <summary>
|
||||
@@ -12,7 +18,7 @@ namespace Octokit.Reactive
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="number">The comment id</param>
|
||||
/// <param name="reaction">The reaction to create </param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="IObservable{Reaction}"/> of < see cref="Reaction"/> representing created reaction for specified comment id.</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 comment id</param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="IObservable{Reaction}"/> of <see cref="Reaction"/>s representing reactions for specified comment id.</returns>
|
||||
IObservable<Reaction> GetAll(string owner, string name, int number);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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
|
||||
{
|
||||
/// <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 ObservableIssueCommentReactionsClient : IObservableIssueCommentReactionsClient
|
||||
{
|
||||
readonly IIssueCommentReactionsClient _client;
|
||||
@@ -26,7 +31,7 @@ namespace Octokit.Reactive
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="number">The comment id</param>
|
||||
/// <param name="reaction">The reaction to create </param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="IObservable{Reaction}"/> of < see cref="Reaction"/> representing created reaction for specified comment id.</returns>
|
||||
public IObservable<Reaction> Create(string owner, string name, int number, NewReaction reaction)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
@@ -43,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 comment id</param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="IObservable{Reaction}"/> of <see cref="Reaction"/>s representing reactions for specified comment id.</returns>
|
||||
public IObservable<Reaction> GetAll(string owner, string name, int number)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
|
||||
@@ -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 IIssueCommentReactionsClient
|
||||
{
|
||||
/// <summary>
|
||||
@@ -13,7 +19,7 @@ namespace Octokit
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="number">The comment id</param>
|
||||
/// <param name="reaction">The reaction to create</param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="Reaction"/> representing created reaction for specified comment id.</returns>
|
||||
Task<Reaction> Create(string owner, string name, int number, NewReaction reaction);
|
||||
|
||||
/// <summary>
|
||||
@@ -23,7 +29,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 comment id</param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="IReadOnlyList{Reaction}"/> of <see cref="Reaction"/>s representing reactions for specified comment id.</returns>
|
||||
Task<IReadOnlyList<Reaction>> GetAll(string owner, string name, int number);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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 IssueCommentReactionsClient : ApiClient, IIssueCommentReactionsClient
|
||||
{
|
||||
public IssueCommentReactionsClient(IApiConnection apiConnection)
|
||||
@@ -19,7 +24,7 @@ namespace Octokit
|
||||
/// <param name="name">The name of the repository</param>
|
||||
/// <param name="number">The comment id</param>
|
||||
/// <param name="reaction">The reaction to create</param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="Reaction"/> representing created reaction for specified comment id.</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 comment id</param>
|
||||
/// <returns></returns>
|
||||
/// <returns>A <see cref="IReadOnlyList{Reaction}"/> of <see cref="Reaction"/>s representing reactions for specified comment id.</returns>
|
||||
public Task<IReadOnlyList<Reaction>> GetAll(string owner, string name, int number)
|
||||
{
|
||||
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
|
||||
|
||||
Reference in New Issue
Block a user