rik/jlibcom
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated javadoc

Browse Source
This commit is contained in:
clay_shooter
2006-10-07 17:30:22 +00:00
parent 745fc749d4
commit e26c507f92
3 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/com/jacob/com/ComException.java
View File

@@ -29,11 +29,11 @@ public abstract class ComException extends JacobException
* that was returned by the underlying com code * that was returned by the underlying com code
**/ **/
protected int hr; protected int hr;
/** TODO: what is this field */ /** No documentation is available at this time. Someone should document this field */
protected int m_helpContext; 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; 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; protected String m_source;
/** /**

6
src/com/jacob/com/LibraryLoader.java
View File

@@ -27,6 +27,11 @@ package com.jacob.com;
* library paths will be used to load the jacob dll. This means it defaults to the * library paths will be used to load the jacob dll. This means it defaults to the
* previous behavior for existing applications. * previous behavior for existing applications.
* <p> * <p>
* 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
* <p>
* Submitted sourceforge ticket 1493647 * Submitted sourceforge ticket 1493647
* @author Scott Dickerson (sjd78) * @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 * Load the jacob dll either from an absolute path defined in system property
* {@link #JACOB_DLL_PATH} or as a general library called "<tt>jacob</tt>". * {@link #JACOB_DLL_PATH} or as a general library called "<tt>jacob</tt>".
* @throws UnsatisfiedLinkError if the library does not exist.
*/ */
public static void loadJacobLibrary() { public static void loadJacobLibrary() {
String path = System.getProperty(JACOB_DLL_PATH); String path = System.getProperty(JACOB_DLL_PATH);

2
src/com/jacob/com/ROT.java
View File

@@ -36,8 +36,8 @@ import java.util.WeakHashMap;
* Prior to 1.9, manual garbage collection was the only option in Jacob, but * 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 * from 1.9 onward, setting the com.jacob.autogc system property
* allows the objects referenced by the ROT to be automatically GCed. * allows the objects referenced by the ROT to be automatically GCed.
* Automatic GC may be preferable in systems with heavy event callbacks.
* <p> * <p>
* TODO : explain when automatic GC is preferable, and when it isn't.
* Is [ 1116101 ] jacob-msg 0284 relevant??? * Is [ 1116101 ] jacob-msg 0284 relevant???
*/ */
public abstract class ROT { public abstract class ROT {