summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAllen Hair <allenhair@google.com>2015-08-26 12:59:30 -0700
committerAllen Hair <allenhair@google.com>2015-08-26 12:59:30 -0700
commitc0588f301a64c74c0c34b677f2930096c789808e (patch)
treea26927415f3f1d2bd2f41db026a9bbb8141a3e5f
parent5b84ce31a8dd81f8ebfa147135f3ee28dc6ff2d3 (diff)
downloadjanktesthelper-c0588f301a64c74c0c34b677f2930096c789808e.tar.gz
Hide internal details from javadocs
Change-Id: I672b93de5b9d766a721e3fe8522fbe3f0a221ae6
-rw-r--r--src/main/java/android/support/test/jank/GfxMonitor.java4
-rw-r--r--src/main/java/android/support/test/jank/JankTest.java2
-rw-r--r--src/main/java/android/support/test/jank/JankTestBase.java3
-rw-r--r--src/main/java/android/support/test/jank/WindowAnimationFrameStatsMonitor.java5
-rw-r--r--src/main/java/android/support/test/jank/WindowContentFrameStatsMonitor.java5
-rw-r--r--src/main/java/android/support/test/jank/internal/JankMonitor.java1
-rw-r--r--src/main/java/android/support/test/jank/internal/JankMonitorFactory.java1
7 files changed, 18 insertions, 3 deletions
diff --git a/src/main/java/android/support/test/jank/GfxMonitor.java b/src/main/java/android/support/test/jank/GfxMonitor.java
index 18f283a..746ea43 100644
--- a/src/main/java/android/support/test/jank/GfxMonitor.java
+++ b/src/main/java/android/support/test/jank/GfxMonitor.java
@@ -16,6 +16,7 @@
package android.support.test.jank;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -24,11 +25,12 @@ import java.lang.annotation.Target;
/** Annotation used to configure a gfx monitor. */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Documented
public @interface GfxMonitor {
/**
* The name of the process to monitor. Alternatively, if the name begins with '#', it specifies
* a method that takes no parameters and returns string as the process name to monitor.
- * */
+ */
String processName();
public static final String KEY_AVG_NUM_JANKY = "gfx-avg-jank";
diff --git a/src/main/java/android/support/test/jank/JankTest.java b/src/main/java/android/support/test/jank/JankTest.java
index c79c6fa..5c1e752 100644
--- a/src/main/java/android/support/test/jank/JankTest.java
+++ b/src/main/java/android/support/test/jank/JankTest.java
@@ -16,6 +16,7 @@
package android.support.test.jank;
+import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@@ -24,6 +25,7 @@ import java.lang.annotation.Target;
/** Annotation used to configure a jank test method. */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
+@Documented
public @interface JankTest {
/** The minimum number of frames expected */
diff --git a/src/main/java/android/support/test/jank/JankTestBase.java b/src/main/java/android/support/test/jank/JankTestBase.java
index a2398c7..d775561 100644
--- a/src/main/java/android/support/test/jank/JankTestBase.java
+++ b/src/main/java/android/support/test/jank/JankTestBase.java
@@ -78,6 +78,9 @@ public class JankTestBase extends InstrumentationTestCase {
return mCurrentIteration;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
protected final void runTest() throws Throwable {
diff --git a/src/main/java/android/support/test/jank/WindowAnimationFrameStatsMonitor.java b/src/main/java/android/support/test/jank/WindowAnimationFrameStatsMonitor.java
index 79b466b..4901cd6 100644
--- a/src/main/java/android/support/test/jank/WindowAnimationFrameStatsMonitor.java
+++ b/src/main/java/android/support/test/jank/WindowAnimationFrameStatsMonitor.java
@@ -21,7 +21,10 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/** Annotation used to configure a window animation frame monitor. */
+/**
+ * Annotation used to configure a window animation frame monitor.
+ * @hide
+ */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface WindowAnimationFrameStatsMonitor {
diff --git a/src/main/java/android/support/test/jank/WindowContentFrameStatsMonitor.java b/src/main/java/android/support/test/jank/WindowContentFrameStatsMonitor.java
index 848aeca..38dc95b 100644
--- a/src/main/java/android/support/test/jank/WindowContentFrameStatsMonitor.java
+++ b/src/main/java/android/support/test/jank/WindowContentFrameStatsMonitor.java
@@ -21,7 +21,10 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-/** Annotation used to configure a window content frame monitor. */
+/**
+ * Annotation used to configure a window content frame monitor.
+ * @hide
+ */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface WindowContentFrameStatsMonitor {
diff --git a/src/main/java/android/support/test/jank/internal/JankMonitor.java b/src/main/java/android/support/test/jank/internal/JankMonitor.java
index 6816f6b..4575c86 100644
--- a/src/main/java/android/support/test/jank/internal/JankMonitor.java
+++ b/src/main/java/android/support/test/jank/internal/JankMonitor.java
@@ -18,6 +18,7 @@ package android.support.test.jank.internal;
import android.os.Bundle;
+/** @hide */
public interface JankMonitor {
public abstract void startIteration() throws Throwable;
diff --git a/src/main/java/android/support/test/jank/internal/JankMonitorFactory.java b/src/main/java/android/support/test/jank/internal/JankMonitorFactory.java
index d3b1cb7..31e6daa 100644
--- a/src/main/java/android/support/test/jank/internal/JankMonitorFactory.java
+++ b/src/main/java/android/support/test/jank/internal/JankMonitorFactory.java
@@ -32,6 +32,7 @@ import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.List;
+/** @hide */
public class JankMonitorFactory {
private static String TAG = "JankTestHelper";