diff --git a/Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs b/Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs index 906a8814..b78e3c0b 100644 --- a/Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs +++ b/Octokit.Reactive/Clients/IObservableIssueCommentsClient.cs @@ -4,6 +4,12 @@ using System.Reactive; namespace Octokit.Reactive { + /// + /// A client for GitHub's Issue Comments API. + /// + /// + /// See the Issue Comments API documentation for more information. + /// public interface IObservableIssueCommentsClient { /// diff --git a/Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs b/Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs index f0011cf2..faa02218 100644 --- a/Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs +++ b/Octokit.Reactive/Clients/ObservableIssueCommentsClient.cs @@ -5,6 +5,12 @@ using Octokit.Reactive.Internal; namespace Octokit.Reactive { + /// + /// A client for GitHub's Issue Comments API. + /// + /// + /// See the Issue Comments API documentation for more information. + /// public class ObservableIssueCommentsClient : IObservableIssueCommentsClient { readonly IIssueCommentsClient _client; diff --git a/Octokit/Clients/IIssueCommentsClient.cs b/Octokit/Clients/IIssueCommentsClient.cs index 147c3b84..6cbd298e 100644 --- a/Octokit/Clients/IIssueCommentsClient.cs +++ b/Octokit/Clients/IIssueCommentsClient.cs @@ -19,7 +19,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue comment id - /// + /// The s for the specified Issue Comment. [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get", Justification = "Method makes a network request")] Task Get(string owner, string name, int id); @@ -30,7 +30,7 @@ namespace Octokit /// http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository /// The owner of the repository /// The name of the repository - /// + /// The list of s for the specified Repository. Task> GetAllForRepository(string owner, string name); /// @@ -40,7 +40,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Options for changing the API response - /// + /// The list of s for the specified Repository. Task> GetAllForRepository(string owner, string name, ApiOptions options); /// @@ -50,7 +50,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue number - /// + /// The list of s for the specified Issue. Task> GetAllForIssue(string owner, string name, int number); /// @@ -61,7 +61,7 @@ namespace Octokit /// The name of the repository /// The issue number /// Options for changing the API response - /// + /// The list of s for the specified Issue. Task> GetAllForIssue(string owner, string name, int number, ApiOptions options); /// @@ -72,7 +72,7 @@ namespace Octokit /// The name of the repository /// The number of the issue /// The new comment to add to the issue - /// + /// The that was just created. Task Create(string owner, string name, int number, string newComment); /// @@ -83,7 +83,7 @@ namespace Octokit /// The name of the repository /// The comment id /// The modified comment - /// + /// The that was just updated. Task Update(string owner, string name, int id, string commentUpdate); /// diff --git a/Octokit/Clients/IssueCommentsClient.cs b/Octokit/Clients/IssueCommentsClient.cs index 2bb32b32..303bc07e 100644 --- a/Octokit/Clients/IssueCommentsClient.cs +++ b/Octokit/Clients/IssueCommentsClient.cs @@ -26,7 +26,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue comment id - /// + /// The s for the specified Issue Comment. public Task Get(string owner, string name, int id) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -41,7 +41,7 @@ namespace Octokit /// http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository /// The owner of the repository /// The name of the repository - /// + /// The list of s for the specified Repository. public Task> GetAllForRepository(string owner, string name) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -57,7 +57,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// Options for changing the API response - /// + /// The list of s for the specified Repository. public Task> GetAllForRepository(string owner, string name, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -74,7 +74,7 @@ namespace Octokit /// The owner of the repository /// The name of the repository /// The issue number - /// + /// The list of s for the specified Issue. public Task> GetAllForIssue(string owner, string name, int number) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -90,7 +90,7 @@ namespace Octokit /// The name of the repository /// The issue number /// Options for changing the API response - /// + /// The list of s for the specified Issue. public Task> GetAllForIssue(string owner, string name, int number, ApiOptions options) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -108,7 +108,7 @@ namespace Octokit /// The name of the repository /// The number of the issue /// The new comment to add to the issue - /// + /// The that was just created. public Task Create(string owner, string name, int number, string newComment) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner"); @@ -126,7 +126,7 @@ namespace Octokit /// The name of the repository /// The comment id /// The modified comment - /// + /// The that was just updated. public Task Update(string owner, string name, int id, string commentUpdate) { Ensure.ArgumentNotNullOrEmptyString(owner, "owner");