Add xml summaries.

StrEnum · Aug 1, 2022 · 8665edb · 8665edb
1 parent 9386b4b
commit 8665edb
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/src/StrEnum.Dapper/StrEnumDapper.cs b/src/StrEnum.Dapper/StrEnumDapper.cs
@@ -6,6 +6,9 @@ namespace StrEnum.Dapper
 {
     public static class StrEnumDapper
     {
+        /// <summary>
+        /// Allows Dapper to handle string enums. Make sure that all of the assemblies that contain string enums have been loaded before calling this method.
+        /// </summary>
         public static void UseStringEnums()
         {
             foreach (var assembly in AppDomain.CurrentDomain.GetAssemblies())

diff --git a/src/StrEnum.Dapper/StrEnumTypeHandler.cs b/src/StrEnum.Dapper/StrEnumTypeHandler.cs
@@ -3,6 +3,10 @@
 
 namespace StrEnum.Dapper
 {
+    /// <summary>
+    /// Provides the way for Dapper to convert string enum members' values from and to strings
+    /// </summary>
+    /// <typeparam name="TEnum"></typeparam>
     public class StrEnumTypeHandler<TEnum>: SqlMapper.TypeHandler<TEnum> where TEnum : StringEnum<TEnum>, new()
     {
         public override void SetValue(IDbDataParameter parameter, TEnum value)