From 42ca81af43ac697b64e011d07c811550488f5913 Mon Sep 17 00:00:00 2001
From: Sam Williamson <samuel.g.williamson@gmail.com>
Date: Thu, 20 Feb 2014 19:57:35 -0500
Subject: [PATCH] Added XML comments to model classes

Added XML comments to model classes: copied feed definitions from github
developer docs
---
 Octokit/Models/Response/Feed.cs     | 31 +++++++++++++++++++++++++
 Octokit/Models/Response/FeedLink.cs | 36 +++++++++++++++++++++++++++++
 2 files changed, 67 insertions(+)

diff --git a/Octokit/Models/Response/Feed.cs b/Octokit/Models/Response/Feed.cs
index fe7d4c1d..f628f80a 100644
--- a/Octokit/Models/Response/Feed.cs
+++ b/Octokit/Models/Response/Feed.cs
@@ -6,17 +6,48 @@ using System.Threading.Tasks;
 
 namespace Octokit
 {
+    /// <summary>
+    /// Lists all the feeds available to the authenticating user:
+    /// </summary>
     [DebuggerDisplay("{DebuggerDisplay,nq}")]
     public class Feed
     {
+        /// <summary>
+        /// The GitHub global public timeline
+        /// </summary>
         public string TimelineUrl { get; set; }
+
+        /// <summary>
+        /// The public timeline for any user, using URI template
+        /// </summary>
         public string UserUrl { get; set; }
+
+        /// <summary>
+        /// The public timeline for the authenticated user
+        /// </summary>
         public string CurrentUserPublicUrl { get; set; }
+
+        /// <summary>
+        /// The private timeline for the authenticated user
+        /// </summary>
         public string CurrentUserUrl { get; set; }
+
+        /// <summary>
+        /// The private timeline for activity created by the authenticated user
+        /// </summary>
         public string CurrentUserActorUrl { get; set; }
+
+        /// <summary>
+        /// The private timeline for the authenticated user for a given organization, using URI template
+        /// </summary>
         public string CurrentUserOrganizationUrl { get; set; }
 
+
+        
         // TODO: Note, the deserializer didn't work when this was named Links
+        /// <summary>
+        /// List of feed urls including feed url and feed type, e.g. application/atom+xml
+        /// </summary>
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "links"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores")]
         public FeedLinks _links { get; set; }
 
diff --git a/Octokit/Models/Response/FeedLink.cs b/Octokit/Models/Response/FeedLink.cs
index 14f4d981..bb1668fb 100644
--- a/Octokit/Models/Response/FeedLink.cs
+++ b/Octokit/Models/Response/FeedLink.cs
@@ -3,19 +3,55 @@ using System.Diagnostics;
 
 namespace Octokit
 {
+    /// <summary>
+    /// Collection of feeds including both url and type
+    /// </summary>
     public class FeedLinks
     {
+        /// <summary>
+        /// The GitHub global public timeline
+        /// </summary>
         public FeedLink Timeline { get; set; }
+
+        /// <summary>
+        /// The public timeline for any user, using URI template
+        /// </summary>
         public FeedLink User { get; set; }
+
+        /// <summary>
+        /// The public timeline for the authenticated user
+        /// </summary>
         public FeedLink CurrentUserPublic { get; set; }
+
+        /// <summary>
+        /// The private timeline for the authenticated user
+        /// </summary>
         public FeedLink CurrentUser { get; set; }
+
+        /// <summary>
+        /// The private timeline for activity created by the authenticated user
+        /// </summary>
         public FeedLink CurrentUserActor { get; set; }
+
+        /// <summary>
+        /// The private timeline for the authenticated user for a given organization, using URI template
+        /// </summary>  
         public FeedLink CurrentUserOrganization { get; set; }
     }
 
+    /// <summary>
+    /// Feed information including feed url and feed type
+    /// </summary>
     public class FeedLink
     {
+        /// <summary>
+        /// Link to feed
+        /// </summary>
         public string Href { get; set; }
+
+        /// <summary>
+        /// Feed type, e.g. application/atom+xml
+        /// </summary>
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1721:PropertyNamesShouldNotMatchGetMethods")]
         public string Type { get; set; }
     }