Added description for SetLibraryLoader

GFNiko · Mar 24, 2023 · b05ce40 · b05ce40
1 parent 978863f
commit b05ce40
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/Whisper.net/Internals/Native/NativeLibraryLoader.cs b/Whisper.net/Internals/Native/NativeLibraryLoader.cs
@@ -9,6 +9,13 @@ public static class NativeLibraryLoader
 {
     private static ILibraryLoader? defaultLibraryLoader = null;
 
+    /// <summary>
+    /// Sets the library loader used to load the native libraries. Overwrite this only if you want some custom loading.
+    /// </summary>
+    /// <param name="libraryLoader">The library loader to be used.</param>
+    /// <remarks>
+    /// It needs to be set before the first <seealso cref="WhisperFactory"/> is created, otherwise it won't have any effect.
+    /// </remarks>
     public static void SetLibraryLoader(ILibraryLoader libraryLoader)
     {
         defaultLibraryLoader = libraryLoader;