Fix more of the docs related warnings

Test: build, unit tests
Bug: 32651845
Change-Id: I05d9c1103cfa522fe63dcbdb12e996b779268e30

19 files changed, 45 insertions, 60 deletions

diff --git a/src/com/android/tradefed/build/BuildInfo.java b/src/com/android/tradefed/build/BuildInfo.java
index a88b46242..8365103ab 100644
--- a/src/com/android/tradefed/build/BuildInfo.java
+++ b/src/com/android/tradefed/build/BuildInfo.java
@@ -15,10 +15,12 @@
  */
 package com.android.tradefed.build;
 
+import com.android.tradefed.device.ITestDevice;
 import com.android.tradefed.log.LogUtil.CLog;
 import com.android.tradefed.util.FileUtil;
 import com.android.tradefed.util.MultiMap;
 import com.android.tradefed.util.UniqueMultiMap;
+
 import com.google.common.base.Objects;
 
 import java.io.File;
@@ -28,7 +30,8 @@ import java.util.Hashtable;
 import java.util.Map;
 
 /**
- * Generic implementation of a {@link IBuildInfo}.
+ * Generic implementation of a {@link IBuildInfo} that should be associated
+ * with a {@link ITestDevice}.
  */
 public class BuildInfo implements IBuildInfo {
     private String mBuildId = UNKNOWN_BUILD_ID;
diff --git a/src/com/android/tradefed/build/OtaDeviceBuildInfo.java b/src/com/android/tradefed/build/OtaDeviceBuildInfo.java
index 7a191113c..959ccea5b 100644
--- a/src/com/android/tradefed/build/OtaDeviceBuildInfo.java
+++ b/src/com/android/tradefed/build/OtaDeviceBuildInfo.java
@@ -16,6 +16,8 @@
 
 package com.android.tradefed.build;
 
+import com.android.tradefed.device.ITestDevice;
+
 import java.io.File;
 import java.util.Collection;
 import java.util.LinkedList;
@@ -23,7 +25,7 @@ import java.util.Map;
 
 /**
  * A {@link IDeviceBuildInfo} used for over-the-air update testing. It is composed of two device
- * builds:
+ * builds for {@link ITestDevice}:
  * <ul>
  * <li>a baseline build image (the build to OTA from).</li>
  * <li>a OTA build (a build to OTA to). Should contain necessary build attributes and associated
diff --git a/src/com/android/tradefed/command/CommandFileWatcher.java b/src/com/android/tradefed/command/CommandFileWatcher.java
index ade061b05..a01589e73 100644
--- a/src/com/android/tradefed/command/CommandFileWatcher.java
+++ b/src/com/android/tradefed/command/CommandFileWatcher.java
@@ -19,6 +19,8 @@ import com.android.tradefed.log.LogUtil.CLog;
 import com.android.tradefed.util.IRunUtil;
 import com.android.tradefed.util.RunUtil;
 
+import com.google.common.annotations.VisibleForTesting;
+
 import java.io.File;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -124,9 +126,8 @@ class CommandFileWatcher extends Thread {
     /**
      * Same as {@link #addCmdFile(File, List, Collection)} but accepts a list of {@link File}s
      * as dependencies
-     *
-     * @VisibleForTesting
      */
+    @VisibleForTesting
     void addCmdFile(File cmdFile, List<String> extraArgs, List<File> dependencies) {
         CommandFile f = new CommandFile(cmdFile, extraArgs, dependencies);
         mCmdFileMap.put(cmdFile.getAbsolutePath(), f);
diff --git a/src/com/android/tradefed/command/CommandScheduler.java b/src/com/android/tradefed/command/CommandScheduler.java
index b0e2b3090..e9db89c51 100644
--- a/src/com/android/tradefed/command/CommandScheduler.java
+++ b/src/com/android/tradefed/command/CommandScheduler.java
@@ -68,7 +68,7 @@ import com.android.tradefed.util.keystore.IKeyStoreClient;
 import com.android.tradefed.util.keystore.IKeyStoreFactory;
 import com.android.tradefed.util.keystore.KeyStoreException;
 
-import org.json.JSONException;
+import com.google.common.annotations.VisibleForTesting;
 
 import java.io.File;
 import java.io.IOException;
@@ -93,6 +93,8 @@ import java.util.concurrent.ScheduledThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
 import java.util.regex.Pattern;
 
+import org.json.JSONException;
+
 /**
  * A scheduler for running TradeFederation commands across all available devices.
  * <p/>
@@ -2000,10 +2002,9 @@ public class CommandScheduler extends Thread implements ICommandScheduler, IComm
     }
 
     /**
-     * Set the command file reloading flag
-     *
-     * @VisibleForTesting
+     * Set the command file reloading flag.
      */
+    @VisibleForTesting
     void setCommandFileReload(boolean b) {
         mReloadCmdfiles = b;
     }
diff --git a/src/com/android/tradefed/command/remote/ExecCommandTracker.java b/src/com/android/tradefed/command/remote/ExecCommandTracker.java
index 2a485ef51..bb9360304 100644
--- a/src/com/android/tradefed/command/remote/ExecCommandTracker.java
+++ b/src/com/android/tradefed/command/remote/ExecCommandTracker.java
@@ -15,8 +15,6 @@
  */
 package com.android.tradefed.command.remote;
 
-import com.google.common.collect.ImmutableMap;
-
 import com.android.tradefed.command.ICommandScheduler.IScheduledInvocationListener;
 import com.android.tradefed.config.Configuration;
 import com.android.tradefed.device.FreeDeviceState;
@@ -24,6 +22,8 @@ import com.android.tradefed.device.ITestDevice;
 import com.android.tradefed.invoker.IInvocationContext;
 import com.android.tradefed.invoker.InvocationContext;
 
+import com.google.common.collect.ImmutableMap;
+
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
 import java.util.HashMap;
@@ -45,6 +45,10 @@ class ExecCommandTracker implements IScheduledInvocationListener {
         mErrorDetails = outputStream.toString();
     }
 
+    /**
+     * {@inheritDoc}
+     * @deprecated use {@link #invocationComplete(IInvocationContext, Map)} instead.
+     */
     @Deprecated
     @Override
     public void invocationComplete(ITestDevice device, FreeDeviceState deviceState) {
diff --git a/src/com/android/tradefed/config/IDeviceConfiguration.java b/src/com/android/tradefed/config/IDeviceConfiguration.java
index 23c4badc8..d0fc2c811 100644
--- a/src/com/android/tradefed/config/IDeviceConfiguration.java
+++ b/src/com/android/tradefed/config/IDeviceConfiguration.java
@@ -77,7 +77,7 @@ public interface IDeviceConfiguration {
     public IDeviceSelection getDeviceRequirements();
 
     /**
-     * Return a shallow copy of this {@IDeviceConfig} object.
+     * Return a shallow copy of this {@link IDeviceConfiguration} object.
      */
     public IDeviceConfiguration clone();
 }
diff --git a/src/com/android/tradefed/device/DeviceManager.java b/src/com/android/tradefed/device/DeviceManager.java
index 982a5b54a..98a0cef40 100644
--- a/src/com/android/tradefed/device/DeviceManager.java
+++ b/src/com/android/tradefed/device/DeviceManager.java
@@ -16,8 +16,6 @@
 
 package com.android.tradefed.device;
 
-import com.google.common.annotations.VisibleForTesting;
-
 import com.android.ddmlib.AndroidDebugBridge.IDeviceChangeListener;
 import com.android.ddmlib.DdmPreferences;
 import com.android.ddmlib.EmulatorConsole;
@@ -42,6 +40,8 @@ import com.android.tradefed.util.SizeLimitedOutputStream;
 import com.android.tradefed.util.StreamUtil;
 import com.android.tradefed.util.TableFormatter;
 
+import com.google.common.annotations.VisibleForTesting;
+
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.lang.reflect.Field;
@@ -841,10 +841,9 @@ public class DeviceManager implements IDeviceManager {
     }
 
     /**
-     * Sorts list by state, then by serial
-     *
-     * @VisibleForTesting
+     * Sorts list by state, then by serial.
      */
+    @VisibleForTesting
     static List<DeviceDescriptor> sortDeviceList(List<DeviceDescriptor> deviceList) {
 
         Comparator<DeviceDescriptor> c = new Comparator<DeviceDescriptor>() {
diff --git a/src/com/android/tradefed/device/StubDevice.java b/src/com/android/tradefed/device/StubDevice.java
index ddd8f4fb3..dba528dab 100644
--- a/src/com/android/tradefed/device/StubDevice.java
+++ b/src/com/android/tradefed/device/StubDevice.java
@@ -143,6 +143,7 @@ public class StubDevice implements IDevice {
 
     /**
      * {@inheritDoc}
+     * @deprecated use {@link #getSystemProperty(String)} instead.
      */
     @Override
     @Deprecated
@@ -160,6 +161,7 @@ public class StubDevice implements IDevice {
 
     /**
      * {@inheritDoc}
+     * @deprecated deprecated in ddmlib with "implementation detail" as reason.
      */
     @Override
     @Deprecated
diff --git a/src/com/android/tradefed/device/TestDeviceOptions.java b/src/com/android/tradefed/device/TestDeviceOptions.java
index f5866380e..5916cee54 100644
--- a/src/com/android/tradefed/device/TestDeviceOptions.java
+++ b/src/com/android/tradefed/device/TestDeviceOptions.java
@@ -77,11 +77,6 @@ public class TestDeviceOptions {
             + "to be available aka fully boot.")
     private long mAvailableTimeout = 6 * 60 * 1000;
 
-    @Deprecated
-    @Option(name = "ping-ip-or-host", description = "default ip or host to ping during "
-            + "connectivity checks; [deprecated] use --ping-url instead.")
-    private String mPingIpOrHost = "www.google.com";
-
     @Option(name = "conn-check-url",
             description = "default URL to be used for connectivity checks.")
     private String mConnCheckUrl = "http://www.google.com";
@@ -260,17 +255,6 @@ public class TestDeviceOptions {
     }
 
     /**
-     * @return the default ip or hostname to ping during connectivity tests.
-     */
-    public String getPingIpOrHost() {
-        return mPingIpOrHost;
-    }
-
-    public void setPingIpOrHost(String ipOrHost) {
-      mPingIpOrHost = ipOrHost;
-    }
-
-    /**
      * @return the default URL to be used for connectivity tests.
      */
     public String getConnCheckUrl() {
diff --git a/src/com/android/tradefed/result/CodeCoverageReporter.java b/src/com/android/tradefed/result/CodeCoverageReporter.java
index 0c9c68689..59e84f6cb 100644
--- a/src/com/android/tradefed/result/CodeCoverageReporter.java
+++ b/src/com/android/tradefed/result/CodeCoverageReporter.java
@@ -46,7 +46,7 @@ import java.util.zip.ZipFile;
  * is in same filesystem location as ddmlib jar.
  */
 @OptionClass(alias = "code-coverage-reporter")
-public class CodeCoverageReporter extends StubTestInvocationListener {
+public class CodeCoverageReporter implements ITestInvocationListener {
     @Option(name = "coverage-metadata-file-path", description =
             "The path of the Emma coverage meta data file used to generate the report.")
     private String mCoverageMetaFilePath = null;
diff --git a/src/com/android/tradefed/result/InvocationToJUnitResultForwarder.java b/src/com/android/tradefed/result/InvocationToJUnitResultForwarder.java
index 330f268e7..ba860f658 100644
--- a/src/com/android/tradefed/result/InvocationToJUnitResultForwarder.java
+++ b/src/com/android/tradefed/result/InvocationToJUnitResultForwarder.java
@@ -17,7 +17,6 @@ package com.android.tradefed.result;
 
 import com.android.ddmlib.Log;
 import com.android.ddmlib.testrunner.TestIdentifier;
-import com.android.tradefed.build.IBuildInfo;
 import com.android.tradefed.invoker.IInvocationContext;
 
 import junit.framework.AssertionFailedError;
@@ -25,10 +24,10 @@ import junit.framework.Test;
 import junit.framework.TestListener;
 import junit.framework.TestResult;
 
-import org.junit.internal.AssumptionViolatedException;
-
 import java.util.Map;
 
+import org.junit.internal.AssumptionViolatedException;
+
 /**
  * A class that listens to {@link ITestInvocationListener} events and forwards them to a
  * {@link junit.framework.TestListener}.
@@ -200,16 +199,6 @@ import java.util.Map;
 
     /**
      * {@inheritDoc}
-     * @deprecated
-     */
-    @Deprecated
-    @Override
-    public void invocationStarted(IBuildInfo buildInfo) {
-        // ignore
-    }
-
-    /**
-     * {@inheritDoc}
      */
     @Override
     public void invocationStarted(IInvocationContext context) {
diff --git a/src/com/android/tradefed/result/LogFile.java b/src/com/android/tradefed/result/LogFile.java
index a4783d08f..d40d8cd8a 100644
--- a/src/com/android/tradefed/result/LogFile.java
+++ b/src/com/android/tradefed/result/LogFile.java
@@ -29,6 +29,7 @@ public class LogFile {
      *
      * @param path The absolute path to the saved file.
      * @param url The URL where the saved file can be accessed.
+     * @deprecated use {@link #LogFile(String, String, boolean, boolean)} instead.
      */
     @Deprecated
     public LogFile(String path, String url) {
diff --git a/src/com/android/tradefed/result/LogSaverResultForwarder.java b/src/com/android/tradefed/result/LogSaverResultForwarder.java
index 06c5e9d82..4b06bdd7f 100644
--- a/src/com/android/tradefed/result/LogSaverResultForwarder.java
+++ b/src/com/android/tradefed/result/LogSaverResultForwarder.java
@@ -43,6 +43,7 @@ public class LogSaverResultForwarder extends ResultForwarder {
 
     /**
      * {@inheritDoc}
+     * @deprecated use {@link #invocationStarted(IInvocationContext)} instead.
      */
     @Override
     @Deprecated
diff --git a/src/com/android/tradefed/result/SubprocessResultsReporter.java b/src/com/android/tradefed/result/SubprocessResultsReporter.java
index af47029f4..d76fdb3d4 100644
--- a/src/com/android/tradefed/result/SubprocessResultsReporter.java
+++ b/src/com/android/tradefed/result/SubprocessResultsReporter.java
@@ -16,7 +16,6 @@
 package com.android.tradefed.result;
 
 import com.android.ddmlib.testrunner.TestIdentifier;
-import com.android.tradefed.build.IBuildInfo;
 import com.android.tradefed.config.Option;
 import com.android.tradefed.invoker.IInvocationContext;
 import com.android.tradefed.log.LogUtil.CLog;
@@ -135,16 +134,6 @@ public class SubprocessResultsReporter implements ITestInvocationListener {
 
     /**
      * {@inheritDoc}
-     * @deprecated
-     */
-    @Deprecated
-    @Override
-    public void invocationStarted(IBuildInfo buildInfo) {
-        // ignore
-    }
-
-    /**
-     * {@inheritDoc}
      */
     @Override
     public void invocationStarted(IInvocationContext context) {
diff --git a/src/com/android/tradefed/targetprep/DeviceCleaner.java b/src/com/android/tradefed/targetprep/DeviceCleaner.java
index 60024f26a..33755550a 100644
--- a/src/com/android/tradefed/targetprep/DeviceCleaner.java
+++ b/src/com/android/tradefed/targetprep/DeviceCleaner.java
@@ -58,6 +58,9 @@ public class DeviceCleaner implements ITargetCleaner {
             + "NONE, REBOOT or FORMAT; defaults to NONE")
     private CleanupAction mCleanupAction = CleanupAction.NONE;
 
+    /**
+     * @deprecated use --post-cleanup SCREEN_OFF option instead.
+     */
     @Deprecated
     @Option(name = "screen-off", description = "After cleanup action, "
             + "if screen should be turned off; defaults to false; "
diff --git a/src/com/android/tradefed/testtype/AndroidJUnitTest.java b/src/com/android/tradefed/testtype/AndroidJUnitTest.java
index 1cb34378f..c16f98655 100644
--- a/src/com/android/tradefed/testtype/AndroidJUnitTest.java
+++ b/src/com/android/tradefed/testtype/AndroidJUnitTest.java
@@ -23,6 +23,8 @@ import com.android.tradefed.device.ITestDevice;
 import com.android.tradefed.result.ITestInvocationListener;
 import com.android.tradefed.util.ArrayUtil;
 
+import com.google.common.annotations.VisibleForTesting;
+
 import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
@@ -292,8 +294,9 @@ public class AndroidJUnitTest extends InstrumentationTest implements IRuntimeHin
     }
 
     /**
-     * @VisibleForTesting
+     * Return if a string is the name of a Class or a Method.
      */
+    @VisibleForTesting
     public boolean isClassOrMethod(String filter) {
         if (filter.contains("#")) {
             return true;
diff --git a/src/com/android/tradefed/testtype/InstalledInstrumentationsTest.java b/src/com/android/tradefed/testtype/InstalledInstrumentationsTest.java
index ca5c33883..39acbc044 100644
--- a/src/com/android/tradefed/testtype/InstalledInstrumentationsTest.java
+++ b/src/com/android/tradefed/testtype/InstalledInstrumentationsTest.java
@@ -50,6 +50,9 @@ public class InstalledInstrumentationsTest
 
     private ITestDevice mDevice;
 
+    /**
+     * @deprecated use --shell-timeout or --test-timeout option instead.
+     */
     @Deprecated
     @Option(name = "timeout",
             description="Deprecated - Use \"shell-timeout\" or \"test-timeout\" instead.")
diff --git a/src/com/android/tradefed/testtype/UiAutomatorRunner.java b/src/com/android/tradefed/testtype/UiAutomatorRunner.java
index f648eb97a..517eb076b 100644
--- a/src/com/android/tradefed/testtype/UiAutomatorRunner.java
+++ b/src/com/android/tradefed/testtype/UiAutomatorRunner.java
@@ -261,6 +261,7 @@ public class UiAutomatorRunner implements IRemoteAndroidTestRunner {
 
     /**
      * {@inheritDoc}
+     * @deprecated use {@link #setMaxTimeToOutputResponse(long, TimeUnit)} instead.
      */
     @Deprecated
     @Override
diff --git a/src/com/android/tradefed/testtype/UiAutomatorTest.java b/src/com/android/tradefed/testtype/UiAutomatorTest.java
index c9be5c7c6..2394d651c 100644
--- a/src/com/android/tradefed/testtype/UiAutomatorTest.java
+++ b/src/com/android/tradefed/testtype/UiAutomatorTest.java
@@ -30,7 +30,6 @@ import com.android.tradefed.result.FileInputStreamSource;
 import com.android.tradefed.result.ITestInvocationListener;
 import com.android.tradefed.result.InputStreamSource;
 import com.android.tradefed.result.LogDataType;
-import com.android.tradefed.result.StubTestInvocationListener;
 import com.android.tradefed.util.FileUtil;
 import com.android.tradefed.util.IRunUtil;
 import com.android.tradefed.util.RunUtil;
@@ -356,7 +355,7 @@ public class UiAutomatorTest implements IRemoteTest, IDeviceTest {
      */
     // TODO replace this once we have a generic event triggered reporter like
     // BugReportCollector
-    private class LoggingWrapper extends StubTestInvocationListener {
+    private class LoggingWrapper implements ITestInvocationListener {
 
         ITestInvocationListener mListener;
         private boolean mLoggedTestFailure = false;