From 3b815b7e5af2fb6f771880dba74863d4f40b638f Mon Sep 17 00:00:00 2001 From: Sven Gothel Date: Fri, 4 May 2012 03:38:38 +0200 Subject: DynamicLibraryBundle: API doc refinement, mention the ClassLoader role. --- src/java/com/jogamp/common/os/DynamicLibraryBundle.java | 15 +++++++++++++-- .../com/jogamp/common/os/DynamicLibraryBundleInfo.java | 6 +++--- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/src/java/com/jogamp/common/os/DynamicLibraryBundle.java b/src/java/com/jogamp/common/os/DynamicLibraryBundle.java index 427f522..f0f1765 100755 --- a/src/java/com/jogamp/common/os/DynamicLibraryBundle.java +++ b/src/java/com/jogamp/common/os/DynamicLibraryBundle.java @@ -44,7 +44,12 @@ import com.jogamp.common.util.RunnableExecutor; *
+ * + *

+ * An {@link DynamicLibraryBundleInfo} instance is being passed in the constructor, + * providing the required information about the tool and glue libraries. + * The ClassLoader of it's implementation is also being used to help locating the native libraries. + *

* An instance provides a complete {@link com.jogamp.common.os.DynamicLookupHelper} * to {@link com.jogamp.gluegen.runtime.ProcAddressTable#reset(com.jogamp.common.os.DynamicLookupHelper) reset} * the {@link com.jogamp.gluegen.runtime.ProcAddressTable}.
@@ -84,7 +89,13 @@ public class DynamicLibraryBundle implements DynamicLookupHelper { } } - /** Instantiates and loads all {@link NativeLibrary}s incl. JNI libraries. */ + /** + * Instantiates and loads all {@link NativeLibrary}s incl. JNI libraries. + *

+ * The ClassLoader of the {@link DynamicLibraryBundleInfo} implementation class + * is being used to help locating the native libraries. + *

+ */ public DynamicLibraryBundle(DynamicLibraryBundleInfo info) { if(null==info) { throw new RuntimeException("Null DynamicLibraryBundleInfo"); diff --git a/src/java/com/jogamp/common/os/DynamicLibraryBundleInfo.java b/src/java/com/jogamp/common/os/DynamicLibraryBundleInfo.java index 8532548..dc90eab 100644 --- a/src/java/com/jogamp/common/os/DynamicLibraryBundleInfo.java +++ b/src/java/com/jogamp/common/os/DynamicLibraryBundleInfo.java @@ -88,11 +88,11 @@ public interface DynamicLibraryBundleInfo { /** * Returns a suitable {@link RunnableExecutor} implementation, which is being used - * to load the tool native libraries. + * to load the tool and glue native libraries. *

* This allows the generic {@link DynamicLibraryBundle} implementation to - * load the tool native libraries on a designated thread. - *

+ * load the native libraries on a designated thread. + *

*

* An implementation may return {@link DynamicLibraryBundle#getDefaultRunnableExecutor()}. *

-- cgit v1.2.3