diff options
| author | Wing Yew Poon <wypoon@cloudera.com> | 2013-03-18 13:55:25 -0700 |
|---|---|---|
| committer | Roman Shaposhnik <rvs@cloudera.com> | 2013-03-24 17:46:54 -0700 |
| commit | 325bc08309cf57dd139e6aca117e69c6cc9d8480 (patch) | |
| tree | 372ac52a22c398e3fe4e47e3412272ae8ca00593 /bigtop-test-framework | |
| parent | ed58bb5e4da8a49a9fc836713330141a7d783917 (diff) | |
BIGTOP-874. make test contracts show up in javadoc
Diffstat (limited to 'bigtop-test-framework')
| -rw-r--r-- | bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Property.java | 3 | ||||
| -rw-r--r-- | bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Variable.java | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Property.java b/bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Property.java index 12e18d3b..19cd657f 100644 --- a/bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Property.java +++ b/bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Property.java @@ -18,6 +18,8 @@ package org.apache.bigtop.itest; +import java.lang.annotation.Documented; + /** Specifies a parameter to be passed into a test via a system property. The parameter may be a String, an int, a long, or a boolean. If the type @@ -26,6 +28,7 @@ package org.apache.bigtop.itest; for the parameter if its type is not boolean; the default value of a boolean parameter is false. */ +@Documented public @interface Property { public static enum Type { STRING, INT, LONG, BOOLEAN; diff --git a/bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Variable.java b/bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Variable.java index f6594d2c..5753a7c8 100644 --- a/bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Variable.java +++ b/bigtop-test-framework/src/main/groovy/org/apache/bigtop/itest/Variable.java @@ -18,12 +18,15 @@ package org.apache.bigtop.itest; +import java.lang.annotation.Documented; + /** Specifies a parameter to be passed into a test via an environment variable. The parameter is a String. By default, the parameter is required. If it is required and a non-null value cannot be found for it, an error may be thrown. */ +@Documented public @interface Variable { String name(); boolean required() default true; |