From a8ab404afc50630329220f4049e1d11d284e0a82 Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Mon, 15 Nov 2010 13:25:18 +0100
Subject: Fix API doc
---
src/java/com/jogamp/common/os/DynamicLibraryBundle.java | 12 ++++++++----
src/java/com/jogamp/common/os/DynamicLookupHelper.java | 10 +++++-----
2 files changed, 13 insertions(+), 9 deletions(-)
(limited to 'src/java/com/jogamp/common/os')
diff --git a/src/java/com/jogamp/common/os/DynamicLibraryBundle.java b/src/java/com/jogamp/common/os/DynamicLibraryBundle.java
index 6e8130f..56029a2 100755
--- a/src/java/com/jogamp/common/os/DynamicLibraryBundle.java
+++ b/src/java/com/jogamp/common/os/DynamicLibraryBundle.java
@@ -39,11 +39,15 @@ import com.jogamp.common.jvm.JNILibLoaderBase;
* <li>The JNI glue-code native library, eg jogl_desktop.dll. From heron this is referred as the Glue</li>
* </ul><br>
* An instance provides a complete {@link com.jogamp.common.os.DynamicLookupHelper}
- * to {@link com.jogamp.gluegen.runtime.ProcAddressTable#reset(com.jogamp.common.os.DynamicLookupHelper lookup)}
+ * to {@link com.jogamp.gluegen.runtime.ProcAddressTable#reset(com.jogamp.common.os.DynamicLookupHelper) reset}
* the {@link com.jogamp.gluegen.runtime.ProcAddressTable}.<br>
- * At construction, it loads the Tool native library, loads Glue native library via
- * {@link com.jogamp.common.os.DynamicLibraryBundleInfo#loadJNILibrary()}
- * and resolves the optional Tool's <pre>GetProcAddress</pre> using {@link com.jogamp.common.os.DynamicLibraryBundleInfo#getToolGetProcAddressFuncNameList()}.
+ * At construction, it:
+ * <ul>
+ * <li> loads the Tool native library via
+ * {@link com.jogamp.common.os.NativeLibrary#open(java.lang.String, java.lang.ClassLoader, boolean) NativeLibrary's open method}</li>
+ * <li> loads the {@link com.jogamp.common.jvm.JNILibLoaderBase#loadLibrary(java.lang.String, java.lang.String[], boolean) Glue native library}</li>
+ * <li> resolves the Tool's {@link com.jogamp.common.os.DynamicLibraryBundleInfo#getToolGetProcAddressFuncNameList() GetProcAddress}. (optional)</li>
+ * </ul>
*/
public class DynamicLibraryBundle implements DynamicLookupHelper {
protected static final boolean DEBUG = NativeLibrary.DEBUG;
diff --git a/src/java/com/jogamp/common/os/DynamicLookupHelper.java b/src/java/com/jogamp/common/os/DynamicLookupHelper.java
index 5da2b67..9c343d5 100755
--- a/src/java/com/jogamp/common/os/DynamicLookupHelper.java
+++ b/src/java/com/jogamp/common/os/DynamicLookupHelper.java
@@ -39,11 +39,11 @@
package com.jogamp.common.os;
-/** Interface callers may use to use the ProcAddressHelper's {@link ProcAddressTable#reset reset}
- helper method to install function pointers into a
- ProcAddressTable. This must typically be written with native
- code. */
-
+/** Interface callers may use ProcAddressHelper's
+ * {@link com.jogamp.gluegen.runtime.ProcAddressTable#reset(com.jogamp.common.os.DynamicLookupHelper) reset}
+ * helper method to install function pointers into a
+ * ProcAddressTable. This must typically be written with native
+ * code. */
public interface DynamicLookupHelper {
/**
* Try to fetch the function pointer for function 'funcName'.
--
cgit v1.2.3