diff --git a/src/com/jacob/com/ComException.java b/src/com/jacob/com/ComException.java index d20c3de..f3275cb 100644 --- a/src/com/jacob/com/ComException.java +++ b/src/com/jacob/com/ComException.java @@ -29,11 +29,11 @@ public abstract class ComException extends JacobException * that was returned by the underlying com code **/ protected int hr; - /** TODO: what is this field */ + /** No documentation is available at this time. Someone should document this field */ protected int m_helpContext; - /** TODO: what is this field */ + /** No documentation is available at this time. Someone should document this field */ protected String m_helpFile; - /** TODO: what is this field */ + /** No documentation is available at this time. Someone should document this field */ protected String m_source; /** diff --git a/src/com/jacob/com/LibraryLoader.java b/src/com/jacob/com/LibraryLoader.java index 65afc6e..ef2cfb4 100644 --- a/src/com/jacob/com/LibraryLoader.java +++ b/src/com/jacob/com/LibraryLoader.java @@ -27,6 +27,11 @@ package com.jacob.com; * library paths will be used to load the jacob dll. This means it defaults to the * previous behavior for existing applications. *

+ * The standard behavior for most applications is that LoadLibrary() will be called + * to load the dll. LoadLibary searches directories specified in the variable + * java.library.path . This is why most test cases specify -Djava.library.path in + * their command line arguments + *

* Submitted sourceforge ticket 1493647 * @author Scott Dickerson (sjd78) */ @@ -41,6 +46,7 @@ public final class LibraryLoader { /** * Load the jacob dll either from an absolute path defined in system property * {@link #JACOB_DLL_PATH} or as a general library called "jacob". + * @throws UnsatisfiedLinkError if the library does not exist. */ public static void loadJacobLibrary() { String path = System.getProperty(JACOB_DLL_PATH); diff --git a/src/com/jacob/com/ROT.java b/src/com/jacob/com/ROT.java index 518c93e..bfa950c 100644 --- a/src/com/jacob/com/ROT.java +++ b/src/com/jacob/com/ROT.java @@ -36,8 +36,8 @@ import java.util.WeakHashMap; * Prior to 1.9, manual garbage collection was the only option in Jacob, but * from 1.9 onward, setting the com.jacob.autogc system property * allows the objects referenced by the ROT to be automatically GCed. + * Automatic GC may be preferable in systems with heavy event callbacks. *

- * TODO : explain when automatic GC is preferable, and when it isn't. * Is [ 1116101 ] jacob-msg 0284 relevant??? */ public abstract class ROT {