From ea25d9967659c11fd419c5c4cec6183b450eb48b Mon Sep 17 00:00:00 2001
From: Kyle Nunery <kyle.nunery@gmail.com>
Date: Sun, 3 Nov 2013 00:23:19 -0500
Subject: [PATCH] Add missing xml comments

---
 Octokit/Clients/IssuesEventsClient.cs | 29 +++++++++++++++++++++++++++
 Octokit/Models/Response/EventInfo.cs  |  9 ++++++---
 Octokit/Models/Response/IssueEvent.cs | 12 ++++++++---
 3 files changed, 44 insertions(+), 6 deletions(-)

diff --git a/Octokit/Clients/IssuesEventsClient.cs b/Octokit/Clients/IssuesEventsClient.cs
index ee064669..640d816a 100644
--- a/Octokit/Clients/IssuesEventsClient.cs
+++ b/Octokit/Clients/IssuesEventsClient.cs
@@ -12,6 +12,16 @@ namespace Octokit
         {
         }
 
+        /// <summary>
+        /// Gets all events for the issue.
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/issues/events/#list-events-for-an-issue
+        /// </remarks>
+        /// <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>
         public Task<IReadOnlyList<EventInfo>> GetForIssue(string owner, string name, int number)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -20,6 +30,15 @@ namespace Octokit
             return ApiConnection.GetAll<EventInfo>(ApiUrls.IssuesEvents(owner, name, number));
         }
 
+        /// <summary>
+        /// Gets all events for the repository.
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/issues/events/#list-events-for-a-repository
+        /// </remarks>
+        /// <param name="owner">The owner of the repository</param>
+        /// <param name="name">The name of the repository</param>
+        /// <returns></returns>
         public Task<IReadOnlyList<IssueEvent>> GetForRepository(string owner, string name)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
@@ -28,6 +47,16 @@ namespace Octokit
             return ApiConnection.GetAll<IssueEvent>(ApiUrls.IssuesEvents(owner, name));
         }
 
+        /// <summary>
+        /// Gets a single event
+        /// </summary>
+        /// <remarks>
+        /// http://developer.github.com/v3/issues/events/#get-a-single-event
+        /// </remarks>
+        /// <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>
         public Task<IssueEvent> Get(string owner, string name, int number)
         {
             Ensure.ArgumentNotNullOrEmptyString(owner, "owner");
diff --git a/Octokit/Models/Response/EventInfo.cs b/Octokit/Models/Response/EventInfo.cs
index 14c81000..96cb7c5e 100644
--- a/Octokit/Models/Response/EventInfo.cs
+++ b/Octokit/Models/Response/EventInfo.cs
@@ -9,20 +9,23 @@ namespace Octokit
         /// </summary>
         public int Id { get; set; }
 
+        /// <summary>
+        /// The URL for this event.
+        /// </summary>
         public Uri Url { get; set; }
 
         /// <summary>
-        /// Always the User that generated the event
+        /// Always the User that generated the event.
         /// </summary>
         public Actor Actor { get; set; }
 
         /// <summary>
-        /// Identifies the actual type of Event that occurred
+        /// Identifies the actual type of Event that occurred.
         /// </summary>
         public EventInfoState InfoState { get; set; }
 
         /// <summary>
-        /// The String SHA of a commit that referenced this Issue
+        /// The String SHA of a commit that referenced this Issue.
         /// </summary>
         public string CommitId { get; set; }
 
diff --git a/Octokit/Models/Response/IssueEvent.cs b/Octokit/Models/Response/IssueEvent.cs
index c1edcb9b..9288be87 100644
--- a/Octokit/Models/Response/IssueEvent.cs
+++ b/Octokit/Models/Response/IssueEvent.cs
@@ -9,20 +9,23 @@ namespace Octokit
         /// </summary>
         public int Id { get; set; }
 
+        /// <summary>
+        /// The URL for this issue/pull request event.
+        /// </summary>
         public Uri Url { get; set; }
 
         /// <summary>
-        /// Always the User that generated the event
+        /// Always the User that generated the event.
         /// </summary>
         public Actor Actor { get; set; }
 
         /// <summary>
-        /// Identifies the actual type of Event that occurred
+        /// Identifies the actual type of Event that occurred.
         /// </summary>
         public EventInfoState InfoState { get; set; }
 
         /// <summary>
-        /// The String SHA of a commit that referenced this Issue
+        /// The String SHA of a commit that referenced this Issue.
         /// </summary>
         public string CommitId { get; set; }
 
@@ -31,6 +34,9 @@ namespace Octokit
         /// </summary>
         public DateTimeOffset CreatedAt { get; set; }
 
+        /// <summary>
+        /// The issue associated to this event.
+        /// </summary>
         public Issue Issue { get; set; }
     }
 }