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

modified XML docs

Browse Source
This commit is contained in:
Alexander Efremov
2016-06-13 17:07:06 +07:00
parent 02c677d832
commit 783d957203
4 changed files with 32 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableIssuesEventsClient.cs
+11 -5
View File
@@ -3,6 +3,12 @@ using System.Diagnostics.CodeAnalysis;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Issue Events API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/events/">Issue Events API documentation</a> for more information.
/// </remarks>
public interface IObservableIssuesEventsClient
{
/// <summary>
@@ -14,7 +20,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 number</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
IObservable<EventInfo> GetAllForIssue(string owner, string name, int number);
/// <summary>
@@ -27,7 +33,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="options">Options for changing the API response</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
IObservable<EventInfo> GetAllForIssue(string owner, string name, int number, ApiOptions options);
/// <summary>
@@ -38,7 +44,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <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{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
IObservable<IssueEvent> GetAllForRepository(string owner, string name);
/// <summary>
@@ -50,7 +56,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">Options for changing the API response</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
IObservable<IssueEvent> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
@@ -62,7 +68,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 event id</param>
/// <returns></returns>
/// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
IObservable<IssueEvent> Get(string owner, string name, int number);
Octokit.Reactive/Clients/ObservableIssuesEventsClient.cs
+11 -5
View File
@@ -4,6 +4,12 @@ using Octokit.Reactive.Internal;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Issue Events API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/events/">Issue Events API documentation</a> for more information.
/// </remarks>
public class ObservableIssuesEventsClient : IObservableIssuesEventsClient
{
readonly IIssuesEventsClient _client;
@@ -26,7 +32,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 number</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
public IObservable<EventInfo> GetAllForIssue(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -45,7 +51,7 @@ namespace Octokit.Reactive
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="options">Options for changing the API response</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
public IObservable<EventInfo> GetAllForIssue(string owner, string name, int number, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -63,7 +69,7 @@ namespace Octokit.Reactive
/// </remarks>
/// <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{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
public IObservable<IssueEvent> GetAllForRepository(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -81,7 +87,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">Options for changing the API response</param>
/// <returns></returns>
/// <returns>A <see cref="IObservable{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
public IObservable<IssueEvent> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -100,7 +106,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 event id</param>
/// <returns></returns>
/// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
public IObservable<IssueEvent> Get(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
Octokit/Clients/IIssuesEventsClient.cs
+5 -5
View File
@@ -21,7 +21,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 number</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
Task<IReadOnlyList<EventInfo>> GetAllForIssue(string owner, string name, int number);
/// <summary>
@@ -34,7 +34,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="options">Options for changing the API response</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
Task<IReadOnlyList<EventInfo>> GetAllForIssue(string owner, string name, int number, ApiOptions options);
/// <summary>
@@ -45,7 +45,7 @@ namespace Octokit
/// </remarks>
/// <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{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
Task<IReadOnlyList<IssueEvent>> GetAllForRepository(string owner, string name);
/// <summary>
@@ -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="options">Options for changing the API response</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
Task<IReadOnlyList<IssueEvent>> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
@@ -69,7 +69,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 event id</param>
/// <returns></returns>
/// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
Task<IssueEvent> Get(string owner, string name, int number);
Octokit/Clients/IssuesEventsClient.cs
+5 -5
View File
@@ -26,7 +26,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 number</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
public Task<IReadOnlyList<EventInfo>> GetAllForIssue(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -45,7 +45,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="number">The issue number</param>
/// <param name="options">Options for changing the API response</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{EventInfo}"/> of <see cref="EventInfo"/>s representing event information for specified number.</returns>
public Task<IReadOnlyList<EventInfo>> GetAllForIssue(string owner, string name, int number, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -63,7 +63,7 @@ namespace Octokit
/// </remarks>
/// <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{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
public Task<IReadOnlyList<IssueEvent>> GetAllForRepository(string owner, string name)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -81,7 +81,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="options">Options for changing the API response</param>
/// <returns></returns>
/// <returns>A <see cref="IReadOnlyList{IssueEvent}"/> of <see cref="IssueEvent"/>s representing issue events for specified repository.</returns>
public Task<IReadOnlyList<IssueEvent>> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -100,7 +100,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 event id</param>
/// <returns></returns>
/// <returns>A <see cref="IssueEvent"/> representing issue event for specified number.</returns>
public Task<IssueEvent> Get(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");