Add some XML comments

ardalis · Jan 17, 2024 · f1c7a54 · f1c7a54
1 parent b7f7dc1
commit f1c7a54
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 0 deletions.
diff --git a/src/SmartEnum.EFCore/SmartEnumConverter.cs b/src/SmartEnum.EFCore/SmartEnumConverter.cs
@@ -5,6 +5,11 @@
 
 namespace Ardalis.SmartEnum.EFCore
 {
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <typeparam name="TEnum"></typeparam>
+    /// <typeparam name="TValue"></typeparam>
     public class SmartEnumConverter<TEnum, TValue> : ValueConverter<TEnum, TValue>
         where TEnum : SmartEnum<TEnum, TValue>
         where TValue : IEquatable<TValue>, IComparable<TValue>
@@ -34,6 +39,12 @@ private static MethodInfo GetBaseFromValueMethod(Type objectType, Type valueType
             return null;
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="value"></param>
+        /// <returns></returns>
+        /// <exception cref="NotImplementedException"></exception>
         public static TEnum GetFromValue(TValue value)
         {
             if (!CanConvert(typeof(TEnum)))
@@ -46,6 +57,9 @@ public static TEnum GetFromValue(TValue value)
             return method.Invoke(null, new[] { (object)value }) as TEnum;
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
         public SmartEnumConverter() : base(item => item.Value, key => GetFromValue(key), null)
         {
         }

diff --git a/src/SmartEnum.JsonNet/SmartFlagEnumNameConverter.cs b/src/SmartEnum.JsonNet/SmartFlagEnumNameConverter.cs
@@ -8,10 +8,26 @@ public class SmartFlagEnumNameConverter<TEnum, TValue> : JsonConverter<TEnum>
     where TEnum : SmartFlagEnum<TEnum, TValue>
     where TValue : struct, IComparable<TValue>, IEquatable<TValue>
     {
+        /// <summary>
+        /// Default to true.
+        /// </summary>
         public override bool CanRead => true;
 
+        /// <summary>
+        /// Defaults to true
+        /// </summary>
         public override bool CanWrite => true;
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="reader"></param>
+        /// <param name="objectType"></param>
+        /// <param name="existingValue"></param>
+        /// <param name="hasExistingValue"></param>
+        /// <param name="serializer"></param>
+        /// <returns></returns>
+        /// <exception cref="JsonSerializationException"></exception>
         public override TEnum ReadJson(JsonReader reader, Type objectType, TEnum existingValue, bool hasExistingValue, JsonSerializer serializer)
         {
             switch (reader.TokenType)

diff --git a/src/SmartEnum.MessagePack/SmartEnumValueFormatter.cs b/src/SmartEnum.MessagePack/SmartEnumValueFormatter.cs
@@ -8,6 +8,12 @@ public class SmartEnumValueFormatter<TEnum, TValue> : IMessagePackFormatter<TEnu
         where TEnum : SmartEnum<TEnum, TValue>
         where TValue : struct, IEquatable<TValue>, IComparable<TValue>
     {
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="writer"></param>
+        /// <param name="value"></param>
+        /// <param name="options"></param>
         public void Serialize(ref MessagePackWriter writer, TEnum value, MessagePackSerializerOptions options)
         {
             if (value is null)
@@ -79,6 +85,12 @@ private void Write(ref MessagePackWriter writer, TValue value)
             throw new ArgumentOutOfRangeException(nameof(value), $"{typeof(TValue)} is not supported."); // should not get to here
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="reader"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public TEnum Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
         {
             if (reader.TryReadNil())
@@ -89,6 +101,12 @@ public TEnum Deserialize(ref MessagePackReader reader, MessagePackSerializerOpti
             return SmartEnum<TEnum, TValue>.FromValue(Read(ref reader));
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="reader"></param>
+        /// <returns></returns>
+        /// <exception cref="ArgumentOutOfRangeException"></exception>
         public TValue Read(ref MessagePackReader reader)
         {
             if (typeof(TValue) == typeof(bool))

diff --git a/src/SmartEnum.ProtoBufNet/SmartEnunNameSurrogate.cs b/src/SmartEnum.ProtoBufNet/SmartEnunNameSurrogate.cs
@@ -3,6 +3,11 @@ namespace Ardalis.SmartEnum.ProtoBufNet
     using System;
     using ProtoBuf;
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <typeparam name="TEnum"></typeparam>
+    /// <typeparam name="TValue"></typeparam>
     [ProtoContract]
     public class SmartEnumNameSurrogate<TEnum, TValue>
         where TEnum : SmartEnum<TEnum, TValue>
@@ -11,6 +16,10 @@ public class SmartEnumNameSurrogate<TEnum, TValue>
         [ProtoMember(1, IsRequired = true)]
         string Name { get; set; }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="smartEnum"></param>
         public static implicit operator SmartEnumNameSurrogate<TEnum, TValue>(TEnum smartEnum)
         {
             if (smartEnum is null)
@@ -19,6 +28,10 @@ public static implicit operator SmartEnumNameSurrogate<TEnum, TValue>(TEnum smar
             return new SmartEnumNameSurrogate<TEnum, TValue> { Name = smartEnum.Name };
         }
 
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="surrogate"></param>
         public static implicit operator TEnum(SmartEnumNameSurrogate<TEnum, TValue> surrogate)
         {
             if (surrogate is null)