From a30008d1e967605ddadac3d3ad6bf8090bb5693e Mon Sep 17 00:00:00 2001 From: "aedampir@gmail.com" Date: Tue, 14 Jun 2016 17:21:27 +0700 Subject: [PATCH] modified XML docs --- Octokit.Reactive/Clients/IObservableIssuesClient.cs | 6 ++++++ Octokit.Reactive/Clients/ObservableIssuesClient.cs | 10 ++++++++++ Octokit/Clients/IIssuesClient.cs | 6 ------ Octokit/Clients/IssuesClient.cs | 4 ++++ 4 files changed, 20 insertions(+), 6 deletions(-) diff --git a/Octokit.Reactive/Clients/IObservableIssuesClient.cs b/Octokit.Reactive/Clients/IObservableIssuesClient.cs index 26efd33d..e4c675e0 100644 --- a/Octokit.Reactive/Clients/IObservableIssuesClient.cs +++ b/Octokit.Reactive/Clients/IObservableIssuesClient.cs @@ -4,6 +4,12 @@ using System.Reactive; namespace Octokit.Reactive { + /// + /// A client for GitHub's Issues API. + /// + /// + /// See the Issues API documentation for more information. + /// public interface IObservableIssuesClient { /// diff --git a/Octokit.Reactive/Clients/ObservableIssuesClient.cs b/Octokit.Reactive/Clients/ObservableIssuesClient.cs index 343c057d..762f3b0c 100644 --- a/Octokit.Reactive/Clients/ObservableIssuesClient.cs +++ b/Octokit.Reactive/Clients/ObservableIssuesClient.cs @@ -5,6 +5,12 @@ using System.Reactive; namespace Octokit.Reactive { + /// + /// A client for GitHub's Issues API. + /// + /// + /// See the Issues API documentation for more information. + /// public class ObservableIssuesClient : IObservableIssuesClient { readonly IIssuesClient _client; @@ -14,20 +20,24 @@ namespace Octokit.Reactive /// Client for managing assignees. /// public IObservableAssigneesClient Assignee { get; private set; } + /// /// Client for managing comments. /// public IObservableIssueCommentsClient Comment { get; private set; } + /// /// Client for reading various event information associated with issues/pull requests. /// This is useful both for display on issue/pull request information pages and also to /// determine who should be notified of comments. /// public IObservableIssuesEventsClient Events { get; private set; } + /// /// Client for managing labels. /// public IObservableIssuesLabelsClient Labels { get; private set; } + /// /// Client for managing milestones. /// diff --git a/Octokit/Clients/IIssuesClient.cs b/Octokit/Clients/IIssuesClient.cs index e830086b..045c34e6 100644 --- a/Octokit/Clients/IIssuesClient.cs +++ b/Octokit/Clients/IIssuesClient.cs @@ -85,7 +85,6 @@ namespace Octokit /// /// Used to filter and sort the list of issues returned /// The created representing requesting a list of issue from the API. - Task> GetAllForCurrent(IssueRequest request); /// @@ -98,7 +97,6 @@ namespace Octokit /// /// Used to filter and sort the list of issues returned /// The created representing requesting a list of issue from the API. - Task> GetAllForCurrent(IssueRequest request, ApiOptions options); /// @@ -110,7 +108,6 @@ namespace Octokit /// http://developer.github.com/v3/issues/#list-issues /// /// The created representing requesting a list of issue from the API. - Task> GetAllForOwnedAndMemberRepositories(); /// @@ -123,7 +120,6 @@ namespace Octokit /// http://developer.github.com/v3/issues/#list-issues /// /// The created representing requesting a list of issue from the API. - Task> GetAllForOwnedAndMemberRepositories(ApiOptions options); /// @@ -134,7 +130,6 @@ namespace Octokit /// /// Used to filter and sort the list of issues returned /// The created representing requesting a list of issue from the API. - Task> GetAllForOwnedAndMemberRepositories(IssueRequest request); /// @@ -146,7 +141,6 @@ namespace Octokit /// Used to filter and sort the list of issues returned /// Options for changing the API response /// The created representing requesting a list of issue from the API. - Task> GetAllForOwnedAndMemberRepositories(IssueRequest request, ApiOptions options); /// diff --git a/Octokit/Clients/IssuesClient.cs b/Octokit/Clients/IssuesClient.cs index 690e17eb..5c61427b 100644 --- a/Octokit/Clients/IssuesClient.cs +++ b/Octokit/Clients/IssuesClient.cs @@ -28,20 +28,24 @@ namespace Octokit /// Client for managing assignees. /// public IAssigneesClient Assignee { get; private set; } + /// /// Client for reading various event information associated with issues/pull requests. /// This is useful both for display on issue/pull request information pages and also to /// determine who should be notified of comments. /// public IIssuesEventsClient Events { get; private set; } + /// /// Client for managing labels. /// public IIssuesLabelsClient Labels { get; private set; } + /// /// Client for managing milestones. /// public IMilestonesClient Milestone { get; private set; } + /// /// Client for managing comments. ///