From 11dd7e58697804202aebb0dd41e24f75992c17d7 Mon Sep 17 00:00:00 2001
From: "aedampir@gmail.com" <aedampir@gmail.com>
Date: Fri, 10 Jun 2016 23:29:48 +0700
Subject: [PATCH] modified XML docs

---
 Octokit.Reactive/Clients/IObservableCommitsClient.cs | 10 ++++++++--
 Octokit.Reactive/Clients/ObservableCommitsClient.cs  | 11 +++++++++--
 Octokit/Clients/CommitsClient.cs                     |  4 ++--
 Octokit/Clients/ICommitsClient.cs                    |  4 ++--
 4 files changed, 21 insertions(+), 8 deletions(-)

diff --git a/Octokit.Reactive/Clients/IObservableCommitsClient.cs b/Octokit.Reactive/Clients/IObservableCommitsClient.cs
index a33beb1c..b559dd65 100644
--- a/Octokit.Reactive/Clients/IObservableCommitsClient.cs
+++ b/Octokit.Reactive/Clients/IObservableCommitsClient.cs
@@ -3,6 +3,12 @@ using System.Diagnostics.CodeAnalysis;
 
 namespace Octokit.Reactive
 {
+    /// <summary>
+    /// A client for GitHub's Git Commits API.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="http://developer.github.com/v3/git/commits/">Git Commits API documentation</a> for more information.
+    /// </remarks>
     public interface IObservableCommitsClient
     {
         /// <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="reference">Tha sha reference of the commit</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="Commit"/> representing commit for specified repository and reference</returns>
         [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
             Justification = "Method makes a network request")]
         IObservable<Commit> Get(string owner, string name, string reference);
@@ -28,7 +34,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="commit">The commit to create</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="IObservable{Commit}"/> of <see cref="Commit"/> representing created commit for specified repository</returns>
         IObservable<Commit> Create(string owner, string name, NewCommit commit);
     }
 }
\ No newline at end of file
diff --git a/Octokit.Reactive/Clients/ObservableCommitsClient.cs b/Octokit.Reactive/Clients/ObservableCommitsClient.cs
index 3eccadc5..7ff8af2c 100644
--- a/Octokit.Reactive/Clients/ObservableCommitsClient.cs
+++ b/Octokit.Reactive/Clients/ObservableCommitsClient.cs
@@ -3,6 +3,12 @@ using System.Reactive.Threading.Tasks;
 
 namespace Octokit.Reactive
 {
+    /// <summary>
+    /// A client for GitHub's Git Commits API.
+    /// </summary>
+    /// <remarks>
+    /// See the <a href="http://developer.github.com/v3/git/commits/">Git Commits API documentation</a> for more information.
+    /// </remarks>
     public class ObservableCommitsClient : IObservableCommitsClient
     {
         readonly ICommitsClient _client;
@@ -10,6 +16,7 @@ namespace Octokit.Reactive
         public ObservableCommitsClient(IGitHubClient client)
         {
             Ensure.ArgumentNotNull(client, "client");
+
             _client = client.Git.Commit;
         }
 
@@ -22,7 +29,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="reference">Tha sha reference of the commit</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="Commit"/> representing commit for specified repository and reference</returns>
         public IObservable<Commit> Get(string owner, string name, string reference)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -41,7 +48,7 @@ namespace Octokit.Reactive
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="commit">The commit to create</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="IObservable{Commit}"/> of <see cref="Commit"/> representing created commit for specified repository</returns>
         public IObservable<Commit> Create(string owner, string name, NewCommit commit)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
diff --git a/Octokit/Clients/CommitsClient.cs b/Octokit/Clients/CommitsClient.cs
index 555b6617..c366d2a5 100644
--- a/Octokit/Clients/CommitsClient.cs
+++ b/Octokit/Clients/CommitsClient.cs
@@ -28,7 +28,7 @@ namespace Octokit
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="reference">Tha sha reference of the commit</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="Commit"/> representing commit for specified repository and reference</returns>
         public Task<Commit> Get(string owner, string name, string reference)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -47,7 +47,7 @@ namespace Octokit
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="commit">The commit to create</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="Commit"/> representing created commit for specified repository</returns>
         public Task<Commit> Create(string owner, string name, NewCommit commit)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
diff --git a/Octokit/Clients/ICommitsClient.cs b/Octokit/Clients/ICommitsClient.cs
index b4227d02..6bde299a 100644
--- a/Octokit/Clients/ICommitsClient.cs
+++ b/Octokit/Clients/ICommitsClient.cs
@@ -20,7 +20,7 @@ namespace Octokit
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="reference">Tha sha reference of the commit</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="Commit"/> representing commit for specified repository and reference</returns>
         [SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Get",
             Justification = "Method makes a network request")]
         Task<Commit> Get(string owner, string name, string reference);
@@ -34,7 +34,7 @@ namespace Octokit
         /// <param name="owner">The owner of the repository</param>
         /// <param name="name">The name of the repository</param>
         /// <param name="commit">The commit to create</param>
-        /// <returns></returns>
+        /// <returns>A <see cref="Commit"/> representing created commit for specified repository</returns>
         Task<Commit> Create(string owner, string name, NewCommit commit);
     }
 }
\ No newline at end of file