Added XML comments to model classes

Added XML comments to model classes: copied feed definitions from github
developer docs
This commit is contained in:
Sam Williamson
2014-02-20 19:57:35 -05:00
parent 6353c77236
commit 42ca81af43
2 changed files with 67 additions and 0 deletions
+31
View File
@@ -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; }
+36
View File
@@ -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; }
}