Adding comments

Author: StanleyGoldman

src/GitHub.Exports/Models/AnnotationModel.cs

@@ -1,21 +1,48 @@
 namespace GitHub.Models
 {
+    /// <summary>
+    /// Model for a single check annotation.
+    /// </summary>
     public class CheckRunAnnotationModel
     {
+        /// <summary>
+        /// The path to the file that this annotation was made on.
+        /// </summary>
         public string BlobUrl { get; set; }
 
+        /// <summary>
+        /// The starting line number (1 indexed).
+        /// </summary>
         public int StartLine { get; set; }
 
+        /// <summary>
+        /// The ending line number (1 indexed).
+        /// </summary>
         public int EndLine { get; set; }
 
+        /// <summary>
+        /// The path that this annotation was made on.
+        /// </summary>
         public string Filename { get; set; }
 
+        /// <summary>
+        /// The annotation's message.
+        /// </summary>
         public string Message { get; set; }
 
+        /// <summary>
+        /// The annotation's title.
+        /// </summary>
         public string Title { get; set; }
 
+        /// <summary>
+        /// The annotation's severity level.
+        /// </summary>
         public CheckAnnotationLevel? AnnotationLevel { get; set; }
 
+        /// <summary>
+        /// Additional information about the annotation.
+        /// </summary>
         public string RawDetails { get; set; }
     }
 }

src/GitHub.Exports/Models/CheckRunModel.cs

@@ -3,22 +3,43 @@
 
 namespace GitHub.Models
 {
+    /// <summary>
+    /// Model for a single check run.
+    /// </summary>
     public class CheckRunModel
     {
+        /// <summary>The conclusion of the check run.</summary>
         public CheckConclusionState? Conclusion { get; set; }
 
+        /// <summary>
+        /// The current status of a Check Run.
+        /// </summary>
         public CheckStatusState Status { get; set; }
 
+        /// <summary>
+        /// Identifies the date and time when the check run was started.
+        /// </summary>
         public DateTimeOffset? StartedAt { get; set; }
 
+        /// <summary>
+        /// Identifies the date and time when the check run was completed.
+        /// </summary>
         public DateTimeOffset? CompletedAt { get; set; }
 
+        /// <summary>The check run's annotations.</summary>
         public List<CheckRunAnnotationModel> Annotations { get; set; }
 
+        /// <summary>The name of the check for this check run.</summary>
         public string Name { get; set; }
 
+        /// <summary>
+        /// The URL from which to find full details of the check run on the integrator's site.
+        /// </summary>
         public string DetailsUrl { get; set; }
 
+        /// <summary>
+        /// The summary of a Check Run.
+        /// </summary>
         public string Summary { get; set; }
     }
 }

src/GitHub.Exports/Models/CheckSuiteModel.cs

@@ -3,16 +3,34 @@
 
 namespace GitHub.Models
 {
+    /// <summary>
+    /// Model for a single check suite.
+    /// </summary>
     public class CheckSuiteModel
     {
+        /// <summary>
+        /// The conclusion of this check suite.
+        /// </summary>
         public CheckConclusionState? Conclusion { get; set; }
 
+        /// <summary>
+        /// The status of this check suite.
+        /// </summary>
         public CheckStatusState Status { get; set; }
 
+        /// <summary>
+        /// Identifies the date and time when the object was created.
+        /// </summary>
         public DateTimeOffset CreatedAt { get; set; }
 
+        /// <summary>
+        /// Identifies the date and time when the object was last updated.
+        /// </summary>
         public DateTimeOffset UpdatedAt { get; set; }
 
+        /// <summary>
+        /// The check runs associated with a check suite.
+        /// </summary>
         public List<CheckRunModel> CheckRuns { get; set; }
     }
 }

src/GitHub.Exports/Models/PullRequestDetailModel.cs

@@ -92,10 +92,13 @@ public class PullRequestDetailModel
         /// </remarks>
         public IReadOnlyList<PullRequestReviewThreadModel> Threads { get; set; }
 
+        /// <summary>
+        /// Gets or sets a collection of pull request Checks Suites
+        /// </summary>
         public List<CheckSuiteModel> CheckSuites { get; set; }
 
         /// <summary>
-        /// Gets or sets a collection of pull request Checks & Statuses
+        /// Gets or sets a collection of pull request Statuses
         /// </summary>
         public List<StatusModel> Statuses { get; set; }
     }