Reference doc cleanup.

Fix doc generation warnings by documenting previously missing parameters, fixing links, etc.

PiperOrigin-RevId: 597654058

Author: brettchabot

core/CHANGELOG.md

@@ -7,6 +7,8 @@
 **Bug Fixes**
 Update Activity Scenario reference documentation to fix missing links
 
+* Reference doc cleanup - document previously missing parameters, fix links, etc
+
 **New Features**
 
 **Breaking Changes**

core/java/androidx/test/core/app/ActivityScenario.java

@@ -206,6 +206,7 @@ public static <A extends Activity> ActivityScenario<A> launch(Class<A> activityC
 
   /**
    * @see #launch(Class)
+   * @param activityClass an activity class to launch
    * @param activityOptions an activity options bundle to be passed along with the intent to start
    *     activity.
    */
@@ -241,6 +242,7 @@ public static <A extends Activity> ActivityScenario<A> launch(Intent startActivi
    * Launches an activity by a given intent and activity options and constructs ActivityScenario
    * with the activity. @see #launch(Intent)
    *
+   * @param startActivityIntent an intent to start the activity
    * @param activityOptions an activity options bundle to be passed along with the intent to start
    *     activity.
    */
@@ -279,6 +281,7 @@ public static <A extends Activity> ActivityScenario<A> launchActivityForResult(
    * Launches an activity of a given class and activity options and constructs ActivityScenario with
    * the activity. @see #launchActivityForResult(Class)
    *
+   * @param activityClass an activity class to launch
    * @param activityOptions an activity options bundle to be passed along with the intent to start
    *     activity.
    */
@@ -318,6 +321,7 @@ public static <A extends Activity> ActivityScenario<A> launchActivityForResult(
    * Launches an activity by a given intent and constructs ActivityScenario with the activity. @see
    * #launchActivityForResult(Intent)
    *
+   * @param startActivityIntent an intent to start the activity
    * @param activityOptions an activity options bundle to be passed along with the intent to start
    *     activity.
    */

espresso/CHANGELOG.md

@@ -18,6 +18,7 @@ The following artifacts were released:
 
 * Fix typo in AdapterDataLoaderAction error message
 * Remove Kotlin collect stdlib calls in Java from espresso
+* Reference doc cleanup - document previously missing parameters, fix links, etc
 
 **New Features**
 

espresso/contrib/java/androidx/test/espresso/contrib/DrawerActions.java

@@ -36,8 +36,8 @@
 /**
  * Espresso actions for using a {@link DrawerLayout}.
  *
- * @see <a href="http://developer.android.com/design/patterns/navigation-drawer.html">Navigation
- *     drawer design guide</a>
+ * <p>See <a href="http://developer.android.com/design/patterns/navigation-drawer.html">Navigation
+ * drawer design guide</a>
  */
 public final class DrawerActions {
   private static final AtomicInteger nextId = new AtomicInteger();

espresso/contrib/java/androidx/test/espresso/contrib/PickerActions.java

@@ -30,16 +30,22 @@
 /**
  * Espresso action for interacting with {@link DatePicker} and {@link TimePicker}.
  *
- * @see <a href="http://developer.android.com/guide/topics/ui/controls/pickers.html">Pickers API
- *     guide</a>
+ * <p>See <a href="http://developer.android.com/guide/topics/ui/controls/pickers.html">Pickers API
+ * guide</a>
  */
 public final class PickerActions {
 
   private PickerActions() {
     // no Instance
   }
 
-  /** Returns a {@link ViewAction} that sets a date on a {@link DatePicker}. */
+  /**
+   * Returns a {@link ViewAction} that sets a date on a {@link DatePicker}.
+   *
+   * @param year The year.
+   * @param monthOfYear The month which is starting from zero.
+   * @param dayOfMonth The day of the month.
+   */
   public static ViewAction setDate(final int year, final int monthOfYear, final int dayOfMonth) {
 
     // monthOfYear which starts with zero in DatePicker widget.
@@ -58,15 +64,19 @@ public String getDescription() {
         return "set date";
       }
 
-      @SuppressWarnings("unchecked")
       @Override
       public Matcher<View> getConstraints() {
         return allOf(isAssignableFrom(DatePicker.class), isDisplayed());
       }
     };
   }
 
-  /** Returns a {@link ViewAction} that sets a time on a {@link TimePicker}. */
+  /**
+   * Returns a {@link ViewAction} that sets a time on a {@link TimePicker}.
+   *
+   * @param hours the hour to set, in the range (0-23).
+   * @param minutes the minute to set, in the range (0-59).
+   */
   public static ViewAction setTime(final int hours, final int minutes) {
 
     return new ViewAction() {
@@ -83,7 +93,6 @@ public String getDescription() {
         return "set time";
       }
 
-      @SuppressWarnings("unchecked")
       @Override
       public Matcher<View> getConstraints() {
         return allOf(isAssignableFrom(TimePicker.class), isDisplayed());

espresso/core/java/androidx/test/espresso/DataInteraction.java

@@ -236,6 +236,8 @@ private DisplayDataMatcher(
      *
      * @param adapterMatcher matcher that matches an {@link AdapterView}
      * @param dataMatcher the data matcher for matching a {@link View} by it's adapter data
+     * @param rootMatcher matcher for view's root
+     * @param atPosition optional position of the view to match
      * @param adapterViewProtocol the {@link AdapterViewProtocol} used for this data interaction
      * @deprecated use {@link #displayDataMatcher(Matcher, Matcher, Matcher, Integer,
      *     AdapterViewProtocol)} instead.

espresso/core/java/androidx/test/espresso/remote/NoopRemoteInteraction.java

@@ -34,6 +34,15 @@ public boolean isRemoteProcess() {
     return false;
   }
 
+  /**
+   * Creates a callable to run Espresso check interaction on remote processes
+   *
+   * @param rootMatcher the root matcher to use.
+   * @param viewMatcher the view matcher to use.
+   * @param iBinders a list of binders to pass along to the remote process instance
+   * @param viewAssertion the view assertion to use.
+   * @return the created Callable
+   */
   @Override
   public Callable<Void> createRemoteCheckCallable(
       Matcher<Root> rootMatcher,
@@ -48,6 +57,15 @@ public Void call() throws Exception {
     };
   }
 
+  /**
+   * Creates a callable to run Espresso perform interaction on remote processes
+   *
+   * @param rootMatcher the root matcher to use.
+   * @param viewMatcher the view matcher to use.
+   * @param iBinders a list of binders to pass along to the remote process instance
+   * @param viewActions one or more actions to execute.
+   * @return
+   */
   @Override
   public Callable<Void> createRemotePerformCallable(
       Matcher<Root> rootMatcher,

espresso/core/java/androidx/test/espresso/remote/RemoteInteraction.java

@@ -44,6 +44,7 @@ public interface RemoteInteraction {
    * @param rootMatcher the root matcher to use.
    * @param viewMatcher the view matcher to use.
    * @param iBinders a list of binders to pass along to the remote process instance
+   * @param viewAssert the view assertion to use.
    * @return a {@link Callable} that will perform the check pending completion of the task.
    */
   Callable<Void> createRemoteCheckCallable(
@@ -60,8 +61,8 @@ Callable<Void> createRemoteCheckCallable(
    *
    * @param rootMatcher the root matcher to use.
    * @param viewMatcher the view matcher to use.
-   * @param viewActions one or more actions to execute.
    * @param iBinders a list of binders to pass along to the remote process instance
+   * @param viewActions one or more actions to execute.
    * @return a {@link Callable} that performs the action.
    */
   Callable<Void> createRemotePerformCallable(

espresso/intents/java/androidx/test/espresso/intent/Intents.java

@@ -157,8 +157,8 @@ public static OngoingStubbing intending(Matcher<Intent> matcher) {
    * Intents.init is called.
    *
    * @param matcher the {@link Matcher} to be applied to captured intents
-   * @throws AssertionFailedError if the given {@link Matcher} did not match any or matched more
-   *     than one of the recorded intents
+   * @throws junit.framework.AssertionFailedError if the given {@link Matcher} did not match any or
+   *     matched more than one of the recorded intents
    */
   public static void intended(Matcher<Intent> matcher) {
     intended(matcher, times(1));
@@ -171,8 +171,9 @@ public static void intended(Matcher<Intent> matcher) {
    * that Intents.init is called.
    *
    * @param matcher the {@link Matcher} to be applied to captured intents
-   * @throws AssertionFailedError if the given {@link Matcher} did not match the expected number of
-   *     recorded intents
+   * @param verificationMode the verification mode to use
+   * @throws junit.framework.AssertionFailedError if the given {@link Matcher} did not match the
+   *     expected number of recorded intents
    */
   public static void intended(
       final Matcher<Intent> matcher, final VerificationMode verificationMode) {

espresso/remote/java/androidx/test/espresso/remote/EspressoRemote.java

@@ -173,6 +173,15 @@ public synchronized boolean isRemoteProcess() {
     return isRemoteProcess;
   }
 
+  /**
+   * Creates a callable to run Espresso check interaction on remote processes
+   *
+   * @param rootMatcher the root matcher to use.
+   * @param viewMatcher the view matcher to use.
+   * @param iBinders a list of binders to pass along to the remote process instance
+   * @param viewAssertion the view assertion to use.
+   * @return the Callable
+   */
   @Override
   public synchronized Callable<Void> createRemoteCheckCallable(
       final Matcher<Root> rootMatcher,