Add missing API Javadoc

Change-Id: I2a76b2d17fb721e9472e98db751b43f3c54f8b90

7 files changed, 60 insertions, 8 deletions

diff --git a/jack-api/src/com/android/jack/api/ConfigNotSupportedException.java b/jack-api/src/com/android/jack/api/ConfigNotSupportedException.java
index 277e7d1..8fea150 100644
--- a/jack-api/src/com/android/jack/api/ConfigNotSupportedException.java
+++ b/jack-api/src/com/android/jack/api/ConfigNotSupportedException.java
@@ -19,7 +19,7 @@ package com.android.jack.api;
 import javax.annotation.Nonnull;
 
 /**
- * STOPSHIP
+ * Thrown when the requested Jack configuration for a given API version is not supported.
  */
 public class ConfigNotSupportedException extends Exception {
   private static final long serialVersionUID = 1L;
diff --git a/jack-api/src/com/android/jack/api/JackConfig.java b/jack-api/src/com/android/jack/api/JackConfig.java
index ee4ec3e..31e56f7 100644
--- a/jack-api/src/com/android/jack/api/JackConfig.java
+++ b/jack-api/src/com/android/jack/api/JackConfig.java
@@ -17,7 +17,7 @@
 package com.android.jack.api;
 
 /**
- * STOPSHIP
+ * Allows to set a configuration for Jack.
  */
 public interface JackConfig {
 }
diff --git a/jack-api/src/com/android/jack/api/JackConfigProvider.java b/jack-api/src/com/android/jack/api/JackConfigProvider.java
index 3d362e0..018b6d2 100644
--- a/jack-api/src/com/android/jack/api/JackConfigProvider.java
+++ b/jack-api/src/com/android/jack/api/JackConfigProvider.java
@@ -21,24 +21,54 @@ import java.util.Collection;
 import javax.annotation.Nonnull;
 
 /**
- * STOPSHIP
+ * Provides instances of {@link JackConfig}.
  */
 public interface JackConfigProvider {
   @Nonnull
   static final String CLASS_NAME = "com.android.jack.api.impl.JackConfigProviderImpl";
 
+  /**
+   * Creates a {@link JackConfig} instance for an interface representing a {@link JackConfig} API
+   * version.
+   * @param cls the {@link JackConfig} API interface
+   * @return the {@link JackConfig} instance
+   * @throws ConfigNotSupportedException If no implementation is found for the given interface.
+   */
   @Nonnull
   <T extends JackConfig> T getConfig(@Nonnull Class<T> cls) throws ConfigNotSupportedException;
 
+  /**
+   * Gives a {@link Collection} containing supported {@link JackConfig} API versions.
+   * @return the supported {@link JackConfig} API versions
+   */
   @Nonnull
   Collection<Class<? extends JackConfig>> getSupportedConfigs();
 
+  /**
+   * The code name of this Jack compiler.
+   * @return the code name
+   */
   @Nonnull
   String getCompilerCodeName();
+
+  /**
+   * The version of this Jack compiler.
+   * @return the version
+   */
   @Nonnull
   String getCompilerVersion();
+
+  /**
+   * The build ID of this Jack compiler.
+   * @return the build ID
+   */
   @Nonnull
   String getCompilerBuildId();
+
+  /**
+   * The code base of this Jack compiler.
+   * @return the code base
+   */
   @Nonnull
   String getCompilerCodeBase();
 }
diff --git a/jack-api/src/com/android/jack/api/v01/AbortException.java b/jack-api/src/com/android/jack/api/v01/AbortException.java
index 70856b6..294efd1 100644
--- a/jack-api/src/com/android/jack/api/v01/AbortException.java
+++ b/jack-api/src/com/android/jack/api/v01/AbortException.java
@@ -19,7 +19,8 @@ package com.android.jack.api.v01;
 import javax.annotation.Nonnull;
 
 /**
- * STOSHIP
+ * A fatal problem that caused Jack to abort. The problem should already have reported, so it is
+ * safe to ignore its message.
  */
 public class AbortException extends Exception {
   private static final long serialVersionUID = 1L;
diff --git a/jack-api/src/com/android/jack/api/v01/Api01CompilationTask.java b/jack-api/src/com/android/jack/api/v01/Api01CompilationTask.java
index 7b9a669..479abc8 100644
--- a/jack-api/src/com/android/jack/api/v01/Api01CompilationTask.java
+++ b/jack-api/src/com/android/jack/api/v01/Api01CompilationTask.java
@@ -18,9 +18,17 @@ package com.android.jack.api.v01;
 
 
 /**
- * STOPSHIP
+ * A task allowing to run the Jack compiler once.
  */
 public interface Api01CompilationTask {
+
+  /**
+   * Runs the Jack compiler. May be called only once.
+   * @throws AbortException If a fatal error occurred during the compilation
+   * @throws UnrecoverableException If an error out of Jack's control occurred
+   * @throws ConfigurationException If there is an error in the configuration
+   * @throws IllegalStateException If Jack is run more than once
+   */
   void run() throws AbortException, UnrecoverableException, ConfigurationException,
       IllegalStateException;
 }
diff --git a/jack-api/src/com/android/jack/api/v01/ConfigurationException.java b/jack-api/src/com/android/jack/api/v01/ConfigurationException.java
index dda1402..63b008f 100644
--- a/jack-api/src/com/android/jack/api/v01/ConfigurationException.java
+++ b/jack-api/src/com/android/jack/api/v01/ConfigurationException.java
@@ -19,7 +19,7 @@ package com.android.jack.api.v01;
 import javax.annotation.Nonnull;
 
 /**
- * All exceptions thrown from the configuration framework.
+ * Thrown when something is wrong in Jack's configuration.
  */
 public class ConfigurationException extends ChainedException {
   private static final long serialVersionUID = 1L;
diff --git a/jack-api/src/com/android/jack/api/v01/DebugInfoLevel.java b/jack-api/src/com/android/jack/api/v01/DebugInfoLevel.java
index 589743b..01db098 100644
--- a/jack-api/src/com/android/jack/api/v01/DebugInfoLevel.java
+++ b/jack-api/src/com/android/jack/api/v01/DebugInfoLevel.java
@@ -17,8 +17,21 @@
 package com.android.jack.api.v01;
 
 /**
- * STOPSHIP
+ * Various levels of debug information.
  */
 public enum DebugInfoLevel {
-  NONE, LINES, FULL
+  /**
+   * No debug info.
+   */
+  NONE,
+
+  /**
+   * Line and source file debug info.
+   */
+  LINES,
+
+  /**
+   * All debug info.
+   */
+  FULL
 }
\ No newline at end of file