From 1633f2a439b43fd6eb8f8c6abf6174aa34495de1 Mon Sep 17 00:00:00 2001
From: Thomas Ardal <thomasardal@gmail.com>
Date: Tue, 14 Nov 2023 11:51:22 +0100
Subject: [PATCH] Documentation

---
 src/Elmah.Io.HResults/HResult.cs | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/Elmah.Io.HResults/HResult.cs b/src/Elmah.Io.HResults/HResult.cs
index 39c5d15..48bda0c 100644
--- a/src/Elmah.Io.HResults/HResult.cs
+++ b/src/Elmah.Io.HResults/HResult.cs
@@ -2,8 +2,14 @@
 
 namespace Elmah.Io.HResults
 {
+    /// <summary>
+    /// Represents a parsed HResult.
+    /// </summary>
     public class HResult
     {
+        /// <summary>
+        /// Parse an integer to a HResult. The method will (unless an exception is thrown) always return a result.
+        /// </summary>
         public static HResult Parse(int i)
         {
             var hresult = new HResult();
@@ -16,9 +22,24 @@ public static HResult Parse(int i)
             return hresult;
         }
 
+        /// <summary>
+        /// Indicates if the HResult is a failure or not.
+        /// </summary>
         public bool IsFailure { get; set; }
+
+        /// <summary>
+        /// Identifies the part of the system for which the HResult applies.
+        /// </summary>
         public string? Facility { get; set; }
+
+        /// <summary>
+        /// The parsed Hex code from the HResult.
+        /// </summary>
         public string? Hex { get; set; }
+
+        /// <summary>
+        /// Identifies a particular condition in the context of the facility.
+        /// </summary>
         public string? ErrorCode { get; set; }
     }
 }