javadoc fix

JorenSix · Jan 19, 2023 · 4f408b0 · 4f408b0
1 parent 606c4ec
commit 4f408b0
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/main/java/be/ugent/jgaborator/util/ZigNativeUtils.java b/src/main/java/be/ugent/jgaborator/util/ZigNativeUtils.java
@@ -62,7 +62,9 @@ private ZigNativeUtils() {
     /**
      * Load a library with OS and architecture detection. The idea is that libraries are found
      *
-     * @param folder the folder of the library with forward slashes
+     * @param folder The folder of the library with forward slashes starting with '/' e.g. '/jni'
+     * @param folder the base name of the library which is then translated to system names gabor is translated
+     *               to gabor.dll on windows or libgabor.dynlib on macOS.
      * @return True if the library is loaded successfully
      */
     public static boolean loadLibraryFromJarWithOSDetection(String folder,String libraryName) {