Add Javadocs

dscho · dscho · commit e2c29a2479cd · 2014-05-26T11:18:29.000-05:00
Signed-off-by: Johannes Schindelin &lt;johannes.schindelin@gmx.de&gt;
diff --git a/src/main/java/org/scijava/plugins/scripting/java/JavaEngine.java b/src/main/java/org/scijava/plugins/scripting/java/JavaEngine.java
@@ -50,6 +50,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import javax.script.ScriptEngine;
 import javax.script.ScriptException;
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
@@ -76,7 +77,13 @@
 import org.xml.sax.SAXException;
 
 /**
- * TODO
+ * A pseudo-{@link ScriptEngine} compiling and executing Java classes.
+ * <p>
+ * Thanks to <a href="https://github.com/scijava/minimaven">MiniMaven</a>, this
+ * script engine can handle individual Java classes as well as trivial Maven
+ * projects (triggered when the proviede script path suggests that the file is
+ * part of a Maven project).
+ * </p>
  * 
  * @author Johannes Schindelin
  */
diff --git a/src/main/java/org/scijava/plugins/scripting/java/JavaEngineBindings.java b/src/main/java/org/scijava/plugins/scripting/java/JavaEngineBindings.java
@@ -42,7 +42,7 @@
 import org.scijava.script.ScriptModule;
 
 /**
- * TODO
+ * Pseudo-{@link Bindings} for the {@link JavaEngine}.
  * 
  * @author Johannes Schindelin
  */
diff --git a/src/main/java/org/scijava/plugins/scripting/java/JavaScriptLanguage.java b/src/main/java/org/scijava/plugins/scripting/java/JavaScriptLanguage.java
@@ -41,7 +41,11 @@
 import org.scijava.script.ScriptLanguage;
 
 /**
- * TODO
+ * Provides Java as a {@link ScriptLanguage}.
+ * <p>
+ * Primarily intended as a back-end for ImageJ2's script editor, this
+ * "script" language implementation compiles and runs Java classes.
+ * </p>
  * 
  * @author Johannes Schindelin
  */

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@`
`42`	`42`	`import org.scijava.script.ScriptModule;`
`43`	`43`
`44`	`44`	`/**`
`45`		`- * TODO`
	`45`	`+ * Pseudo-{@link Bindings} for the {@link JavaEngine}.`
`46`	`46`	`*`
`47`	`47`	`* @author Johannes Schindelin`
`48`	`48`	`*/`