From 783d9572032542395cfaa2cde5345c8678f2a925 Mon Sep 17 00:00:00 2001
From: Alexander Efremov <aedampir@gmail.com>
Date: Mon, 13 Jun 2016 17:07:06 +0700
Subject: [PATCH] modified XML docs

---
 .../Clients/IObservableIssuesEventsClient.cs     | 16 +++++++++++-----
 .../Clients/ObservableIssuesEventsClient.cs      | 16 +++++++++++-----
 Octokit/Clients/IIssuesEventsClient.cs           | 10 +++++-----
 Octokit/Clients/IssuesEventsClient.cs            | 10 +++++-----
 4 files changed, 32 insertions(+), 20 deletions(-)

diff --git a/Octokit.Reactive/Clients/IObservableIssuesEventsClient.cs b/Octokit.Reactive/Clients/IObservableIssuesEventsClient.cs
index 50971915..e3317e05 100644
--- a/Octokit.Reactive/Clients/IObservableIssuesEventsClient.cs
+++ b/Octokit.Reactive/Clients/IObservableIssuesEventsClient.cs
@@ -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);
diff --git a/Octokit.Reactive/Clients/ObservableIssuesEventsClient.cs b/Octokit.Reactive/Clients/ObservableIssuesEventsClient.cs
index 8e735fc9..a0d81d14 100644
--- a/Octokit.Reactive/Clients/ObservableIssuesEventsClient.cs
+++ b/Octokit.Reactive/Clients/ObservableIssuesEventsClient.cs
@@ -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");
diff --git a/Octokit/Clients/IIssuesEventsClient.cs b/Octokit/Clients/IIssuesEventsClient.cs
index 78ed5a43..7f410896 100644
--- a/Octokit/Clients/IIssuesEventsClient.cs
+++ b/Octokit/Clients/IIssuesEventsClient.cs
@@ -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);
diff --git a/Octokit/Clients/IssuesEventsClient.cs b/Octokit/Clients/IssuesEventsClient.cs
index 1805563f..648bfeac 100644
--- a/Octokit/Clients/IssuesEventsClient.cs
+++ b/Octokit/Clients/IssuesEventsClient.cs
@@ -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");