add some doc, remove some unused using

Valheim-Modding · Mar 18, 2021 · 348eabf · 348eabf
1 parent 795344c
commit 348eabf
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 2 deletions.
diff --git a/ValheimLib/Language.cs b/ValheimLib/Language.cs
@@ -1,7 +1,6 @@
 using MonoMod.RuntimeDetour;
 using System;
 using System.Collections.Generic;
-using ValheimLib.Util;
 using ValheimLib.Util.Reflection;
 
 namespace ValheimLib

diff --git a/ValheimLib/Mock.cs b/ValheimLib/Mock.cs
@@ -3,6 +3,10 @@
 
 namespace ValheimLib
 {
+    /// <summary>
+    /// Helper class for creating Mock for a given vanilla Component
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
     public static class Mock<T> where T : Component
     {
         public static T Create(string name)

diff --git a/ValheimLib/ODB/ObjectDBHelper.cs b/ValheimLib/ODB/ObjectDBHelper.cs
@@ -4,6 +4,9 @@
 
 namespace ValheimLib.ODB
 {
+    /// <summary>
+    /// Helper class for registering custom items, recipes, and status effects to the game ObjectDB
+    /// </summary>
     public static class ObjectDBHelper
     {
         internal static readonly List<CustomItem> CustomItems = new List<CustomItem>();

diff --git a/ValheimLib/ODB/SaveCustomData.cs b/ValheimLib/ODB/SaveCustomData.cs
@@ -1,6 +1,5 @@
 using System.IO;
 using System.Linq;
-using UnityEngine.Assertions;
 
 namespace ValheimLib.ODB
 {

diff --git a/ValheimLib/Util/Events/EventsHelper.cs b/ValheimLib/Util/Events/EventsHelper.cs
@@ -2,8 +2,15 @@
 
 namespace ValheimLib.Util.Events
 {
+    /// <summary>
+    /// Helper class for C# Events
+    /// </summary>
     public static class EventsHelper
     {
+        /// <summary>
+        /// Try catch the delegate chain so that it doesnt break on the first failing Delegate
+        /// </summary>
+        /// <param name="events"></param>
         public static void SafeInvoke(this Action events)
         {
             if (events == null)
@@ -24,6 +31,12 @@ public static void SafeInvoke(this Action events)
             }
         }
 
+        /// <summary>
+        /// Try catch the delegate chain so that it doesnt break on the first failing Delegate
+        /// </summary>
+        /// <typeparam name="TArg1"></typeparam>
+        /// <param name="events"></param>
+        /// <param name="arg1"></param>
         public static void SafeInvoke<TArg1>(this Action<TArg1> events, TArg1 arg1)
         {
             if (events == null)