Added documentation to EnumUtils.cs

topnax · topnax · commit d8a7423c4ee8 · 2021-05-21T07:57:59.000+02:00
diff --git a/Utils/EnumUtils.cs b/Utils/EnumUtils.cs
@@ -4,8 +4,13 @@
 
 namespace Utils
 {
-    public class EnumUtils
+    public static class EnumUtils
     {
+        /// <summary>
+        /// Returns all possible values of the given enumerable
+        /// </summary>
+        /// <typeparam name="TEnum">Enumerable whose values are to be returned</typeparam>
+        /// <returns>List of possible values of the given enumerable</returns>
         public static List<TEnum> GetEnumList<TEnum>() where TEnum : Enum 
             => ((TEnum[])Enum.GetValues(typeof(TEnum))).ToList();
     }

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,13 @@`
`4`	`4`
`5`	`5`	`namespace Utils`
`6`	`6`	`{`
`7`		`- public class EnumUtils`
	`7`	`+ public static class EnumUtils`
`8`	`8`	`{`
	`9`	`+ /// <summary>`
	`10`	`+ /// Returns all possible values of the given enumerable`
	`11`	`+ /// </summary>`
	`12`	`+ /// <typeparam name="TEnum">Enumerable whose values are to be returned</typeparam>`
	`13`	`+ /// <returns>List of possible values of the given enumerable</returns>`
`9`	`14`	`public static List<TEnum> GetEnumList<TEnum>() where TEnum : Enum`
`10`	`15`	`=> ((TEnum[])Enum.GetValues(typeof(TEnum))).ToList();`
`11`	`16`	`}`