Merge pull request #1714 from sbt/wip/bytecode-enhancement

Expose mechanism whereby bytecode enhancement can be run *before* saving incremental compiler hashes.

interface/src/main/java/xsbti/compile/CompileProgress.java

@@ -1,5 +1,10 @@
 package xsbti.compile;
 
+/**
+ * An API for reporting when files are being compiled.
+ *
+ * Note; This is tied VERY SPECIFICALLY to scala.
+ */
 public interface CompileProgress {
 	void startUnit(String phase, String unitPath);
 

interface/src/main/java/xsbti/compile/GlobalsCache.java

@@ -3,6 +3,9 @@ package xsbti.compile;
 import xsbti.Logger;
 import xsbti.Reporter;
 
+/**
+ * An interface which lets us know how to retrieve cached compiler instances form the current JVM.
+ */
 public interface GlobalsCache
 {
 	public CachedCompiler apply(String[] args, Output output, boolean forceNew, CachedCompilerProvider provider, Logger log, Reporter reporter);

interface/src/main/java/xsbti/compile/IncrementalCompiler.java

@@ -44,8 +44,18 @@ public interface IncrementalCompiler<Analysis, ScalaCompiler>
 	* @param instance The Scala version to use
 	* @param interfaceJar The compiler interface jar compiled for the Scala version being used
 	* @param options Configures how arguments to the underlying Scala compiler will be built.
+    *
 	*/
+    @Deprecated
 	ScalaCompiler newScalaCompiler(ScalaInstance instance, File interfaceJar, ClasspathOptions options, Logger log);
+    /**
+     * Creates a compiler instance that can be used by the `compile` method.
+     *
+     * @param instance The Scala version to use
+     * @param interfaceJar The compiler interface jar compiled for the Scala version being used
+     * @param options Configures how arguments to the underlying Scala compiler will be built.
+     */
+    ScalaCompiler newScalaCompiler(ScalaInstance instance, File interfaceJar, ClasspathOptions options);
 
 	/** 
 	* Compiles the source interface for a Scala version.  The resulting jar can then be used by the `newScalaCompiler` method