summaryrefslogtreecommitdiffstats
path: root/jack-api
diff options
context:
space:
mode:
authorBenoit Lamarche <benoitlamarche@google.com>2015-03-09 15:19:27 +0100
committerBenoit Lamarche <benoitlamarche@google.com>2015-03-09 15:19:27 +0100
commit3cd427a2245e839be7dab9140d0dbac8650dc3b8 (patch)
tree82eb8311cdc03299ddf9fc2bac1afc7f988a98d4 /jack-api
parent20ef3af418a5acd49b202a5b9441127689a79508 (diff)
downloadtoolchain_jack-3cd427a2245e839be7dab9140d0dbac8650dc3b8.zip
toolchain_jack-3cd427a2245e839be7dab9140d0dbac8650dc3b8.tar.gz
toolchain_jack-3cd427a2245e839be7dab9140d0dbac8650dc3b8.tar.bz2
Add Javadoc for Enums of API
Change-Id: I2c7dffe2e2af1eac9d8ddce3066e07a940349aea
Diffstat (limited to 'jack-api')
-rw-r--r--jack-api/src/com/android/jack/api/v01/MultiDexKind.java17
-rw-r--r--jack-api/src/com/android/jack/api/v01/ResourceCollisionPolicy.java10
-rw-r--r--jack-api/src/com/android/jack/api/v01/TypeCollisionPolicy.java10
3 files changed, 33 insertions, 4 deletions
diff --git a/jack-api/src/com/android/jack/api/v01/MultiDexKind.java b/jack-api/src/com/android/jack/api/v01/MultiDexKind.java
index 8076fb0..59bcf70 100644
--- a/jack-api/src/com/android/jack/api/v01/MultiDexKind.java
+++ b/jack-api/src/com/android/jack/api/v01/MultiDexKind.java
@@ -17,8 +17,21 @@
package com.android.jack.api.v01;
/**
- * Available mode for the multidex feature
+ * The method to use to split in several dex files.
*/
public enum MultiDexKind {
- NONE, NATIVE, LEGACY
+ /**
+ * Do not split.
+ */
+ NONE,
+
+ /**
+ * Multidex split targeting L-or-more platforms.
+ */
+ NATIVE,
+
+ /**
+ * Multidex split targeting K-or-less platforms.
+ */
+ LEGACY
} \ No newline at end of file
diff --git a/jack-api/src/com/android/jack/api/v01/ResourceCollisionPolicy.java b/jack-api/src/com/android/jack/api/v01/ResourceCollisionPolicy.java
index 4e5881e..ad68fd9 100644
--- a/jack-api/src/com/android/jack/api/v01/ResourceCollisionPolicy.java
+++ b/jack-api/src/com/android/jack/api/v01/ResourceCollisionPolicy.java
@@ -20,5 +20,13 @@ package com.android.jack.api.v01;
* How to handle resource collisions.
*/
public enum ResourceCollisionPolicy {
- KEEP_FIRST, FAIL
+ /**
+ * In case of collision between resources, keep the first resource that was encountered.
+ */
+ KEEP_FIRST,
+
+ /**
+ * In case of collision between resources, fail.
+ */
+ FAIL
}
diff --git a/jack-api/src/com/android/jack/api/v01/TypeCollisionPolicy.java b/jack-api/src/com/android/jack/api/v01/TypeCollisionPolicy.java
index dcefc06..8e19505 100644
--- a/jack-api/src/com/android/jack/api/v01/TypeCollisionPolicy.java
+++ b/jack-api/src/com/android/jack/api/v01/TypeCollisionPolicy.java
@@ -20,5 +20,13 @@ package com.android.jack.api.v01;
* How to handle type collisions.
*/
public enum TypeCollisionPolicy {
- KEEP_FIRST, FAIL
+ /**
+ * In case of collision between types, keep the first type that was encountered.
+ */
+ KEEP_FIRST,
+
+ /**
+ * In case of collision between types, fail.
+ */
+ FAIL
}