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

added XML docs

Browse Source
This commit is contained in:
aedampir@gmail.com
2016-06-14 14:10:30 +07:00
parent 27d0077aae
commit 7d65a8db4e
4 changed files with 26 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs
+6
View File
@@ -4,6 +4,12 @@ using System.Reactive;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Issue Comments API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/comments/">Issue Comments API documentation</a> for more information.
/// </remarks>
public interface IObservableIssueCommentsClient
{
/// <summary>
Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs
+6
View File
@@ -5,6 +5,12 @@ using Octokit.Reactive.Internal;
namespace Octokit.Reactive
{
/// <summary>
/// A client for GitHub's Issue Comments API.
/// </summary>
/// <remarks>
/// See the <a href="http://developer.github.com/v3/issues/comments/">Issue Comments API documentation</a> for more information.
/// </remarks>
public class ObservableIssueCommentsClient : IObservableIssueCommentsClient
{
readonly IIssueCommentsClient _client;
Octokit/Clients/IIssueCommentsClient.cs
+7 -7
View File
@@ -19,7 +19,7 @@ namespace Octokit
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="id">The issue comment id</param>
/// <returns></returns>
/// <returns>The <see cref="IssueComment"/>s for the specified Issue Comment.</returns>
[SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
Justification = "Method makes a network request")]
Task<IssueComment> Get(string owner, string name, int id);
@@ -30,7 +30,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns></returns>
/// <returns>The list of <see cref="IssueComment"/>s for the specified Repository.</returns>
Task<IReadOnlyList<IssueComment>> GetAllForRepository(string owner, string name);
/// <summary>
@@ -40,7 +40,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>The list of <see cref="IssueComment"/>s for the specified Repository.</returns>
Task<IReadOnlyList<IssueComment>> GetAllForRepository(string owner, string name, ApiOptions options);
/// <summary>
@@ -50,7 +50,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>The list of <see cref="IssueComment"/>s for the specified Issue.</returns>
Task<IReadOnlyList<IssueComment>> GetAllForIssue(string owner, string name, int number);
/// <summary>
@@ -61,7 +61,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>The list of <see cref="IssueComment"/>s for the specified Issue.</returns>
Task<IReadOnlyList<IssueComment>> GetAllForIssue(string owner, string name, int number, ApiOptions options);
/// <summary>
@@ -72,7 +72,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="number">The number of the issue</param>
/// <param name="newComment">The new comment to add to the issue</param>
/// <returns></returns>
/// <returns>The <see cref="IssueComment"/> that was just created.</returns>
Task<IssueComment> Create(string owner, string name, int number, string newComment);
/// <summary>
@@ -83,7 +83,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="id">The comment id</param>
/// <param name="commentUpdate">The modified comment</param>
/// <returns></returns>
/// <returns>The <see cref="IssueComment"/> that was just updated.</returns>
Task<IssueComment> Update(string owner, string name, int id, string commentUpdate);
/// <summary>
Octokit/Clients/IssueCommentsClient.cs
+7 -7
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="id">The issue comment id</param>
/// <returns></returns>
/// <returns>The <see cref="IssueComment"/>s for the specified Issue Comment.</returns>
public Task<IssueComment> Get(string owner, string name, int id)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -41,7 +41,7 @@ namespace Octokit
/// <remarks>http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository</remarks>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <returns></returns>
/// <returns>The list of <see cref="IssueComment"/>s for the specified Repository.</returns>
public Task<IReadOnlyList<IssueComment>> GetAllForRepository(string owner, string name)
{
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="options">Options for changing the API response</param>
/// <returns></returns>
/// <returns>The list of <see cref="IssueComment"/>s for the specified Repository.</returns>
public Task<IReadOnlyList<IssueComment>> GetAllForRepository(string owner, string name, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -74,7 +74,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>The list of <see cref="IssueComment"/>s for the specified Issue.</returns>
public Task<IReadOnlyList<IssueComment>> GetAllForIssue(string owner, string name, int number)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -90,7 +90,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>The list of <see cref="IssueComment"/>s for the specified Issue.</returns>
public Task<IReadOnlyList<IssueComment>> GetAllForIssue(string owner, string name, int number, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -108,7 +108,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="number">The number of the issue</param>
/// <param name="newComment">The new comment to add to the issue</param>
/// <returns></returns>
/// <returns>The <see cref="IssueComment"/> that was just created.</returns>
public Task<IssueComment> Create(string owner, string name, int number, string newComment)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -126,7 +126,7 @@ namespace Octokit
/// <param name="name">The name of the repository</param>
/// <param name="id">The comment id</param>
/// <param name="commentUpdate">The modified comment</param>
/// <returns></returns>
/// <returns>The <see cref="IssueComment"/> that was just updated.</returns>
public Task<IssueComment> Update(string owner, string name, int id, string commentUpdate)
{
Ensure.ArgumentNotNullOrEmptyString(owner, "owner");