zoriya/octokit.net
1
0
Fork 0
mirror of https://github.com/zoriya/octokit.net.git synced 2026-06-05 03:30:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

modified xml docs

Browse Source
This commit is contained in:
Alexander Efremov
2016-06-12 12:16:21 +07:00
parent f05f6dcab9
commit 0aca4f8863
4 changed files with 25 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableAssigneesClient.cs
+9 -3
View File
@@ -2,6 +2,12 @@
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Issue Assignees API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/assignees/">Issue Assignees API documentation</a> for more information.
/// </remarks>
public interface IObservableAssigneesClient
{
/// <summary>
@@ -9,7 +15,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/> representing assignees of specified repository.</returns>
IObservable<User> GetAllForRepository(string owner, string name);
/// <summary>
@@ -18,7 +24,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">The options to change API's behaviour.</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/> representing assignees of specified repository.</returns>
IObservable<User> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
@@ -27,7 +33,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="assignee">Username of the prospective assignee</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{Bool}"/> of <see cref="bool"/> representing is a user is an assignee for a repository.</returns>
IObservable<bool> CheckAssignee(string owner, string name, string assignee);
}
}
Octokit.Reactive/Clients/ObservableAssigneesClient.cs
+10 -4
View File
@@ -4,6 +4,12 @@ using Octokit.Reactive.Internal;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Issue Assignees API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/assignees/">Issue Assignees API documentation</a> for more information.
/// </remarks>
public class ObservableAssigneesClient : IObservableAssigneesClient
{
readonly IAssigneesClient _client;
@@ -22,7 +28,7 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/> representing assignees of specified repository.</returns>
public IObservable<User> GetAllForRepository(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -36,8 +42,8 @@ namespace Octokit.Reactive
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">The options to change API's behaviour</param>
/// <returns></returns>
/// <param name="options">The options to change API's behaviour.</param>
/// <returns>A <see cref="IObservable{User}"/> of <see cref="User"/> representing assignees of specified repository.</returns>
public IObservable<User> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -53,7 +59,7 @@ namespace Octokit.Reactive
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="assignee">Username of the prospective assignee</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{Bool}"/> of <see cref="bool"/> representing is a user is an assignee for a repository.</returns>
public IObservable<bool> CheckAssignee(string owner, string name, string assignee)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Octokit/Clients/AssigneesClient.cs
+3 -3
View File
@@ -24,7 +24,7 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{User}"/> of <see cref="User"/> representing assignees of specified repository.</returns>
public Task<IReadOnlyList<User>> GetAllForRepository(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -39,7 +39,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">The options to change API's response.</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{User}"/> of <see cref="User"/> representing assignees of specified repository.</returns>
public Task<IReadOnlyList<User>> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -57,7 +57,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="assignee">Username of the prospective assignee</param>
/// <returns></returns>
/// <returns>A <see cref="bool"/> representing is a user is an assignee for a repository.</returns>
public async Task<bool> CheckAssignee(string owner, string name, string assignee)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Octokit/Clients/IAssigneesClient.cs
+3 -3
View File
@@ -16,7 +16,7 @@ namespace Octokit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{User}"/> of <see cref="User"/> representing assignees of specified repository.</returns>
Task<IReadOnlyList<User>> GetAllForRepository(string owner, string name);
/// <summary>
@@ -25,7 +25,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">The options to change API's response.</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{User}"/> of <see cref="User"/> representing assignees of specified repository.</returns>
Task<IReadOnlyList<User>> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
@@ -34,7 +34,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="assignee">Username of the prospective assignee</param>
/// <returns></returns>
/// <returns>A <see cref="bool"/> representing is a user is an assignee for a repository.</returns>
Task<bool> CheckAssignee(string owner, string name, string assignee);
}
}