diff options
author | Sven Gothel <[email protected]> | 2012-05-04 03:38:38 +0200 |
---|---|---|
committer | Sven Gothel <[email protected]> | 2012-05-04 03:38:38 +0200 |
commit | 3b815b7e5af2fb6f771880dba74863d4f40b638f (patch) | |
tree | 5d8c2079caa6b91bf4f6a047c9f92dbb86d53ba6 /src | |
parent | 389035210e6fc7742a2a11575c7bbfc8f08987a5 (diff) |
DynamicLibraryBundle: API doc refinement, mention the ClassLoader role.
Diffstat (limited to 'src')
-rwxr-xr-x | src/java/com/jogamp/common/os/DynamicLibraryBundle.java | 15 | ||||
-rw-r--r-- | src/java/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; * <ul> * <li>The to-be-glued native library, eg OpenGL32.dll. From here on this is referred as the Tool.</li> * <li>The JNI glue-code native library, eg jogl_desktop.dll. From here on this is referred as the Glue</li> - * </ul><br> + * </ul> + * <p> + * 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. + * </p> * 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}.<br> @@ -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. + * <p> + * The ClassLoader of the {@link DynamicLibraryBundleInfo} implementation class + * is being used to help locating the native libraries. + * </p> + */ 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 <code>tool</code> native libraries. + * to load the <code>tool</code> and <code>glue</code> native libraries. * <p> * This allows the generic {@link DynamicLibraryBundle} implementation to - * load the <code>tool</code> native libraries on a designated thread. - * </p> + * load the native libraries on a designated thread. + * </p> * <p> * An implementation may return {@link DynamicLibraryBundle#getDefaultRunnableExecutor()}. * </p> |