Fix missing documentation in androidx core library
Will follow up on messages.ignore update once docs-public uses a fixed
version of sources.
Test: ./gradlew docs-tip-of-tree:docs -> no more warnings from core
Change-Id: Ief24137fc8d387a0790aae43a8cbdc23320d61e7
diff --git a/core/core/src/main/java/androidx/core/app/ActivityCompat.java b/core/core/src/main/java/androidx/core/app/ActivityCompat.java
index dea976c..8f27f72 100644
--- a/core/core/src/main/java/androidx/core/app/ActivityCompat.java
+++ b/core/core/src/main/java/androidx/core/app/ActivityCompat.java
@@ -363,6 +363,7 @@
* the target class type is unconstrained, an explicit cast may be
* necessary.
*
+ * @param activity activity in which to find a view.
* @param id the ID to search for
* @return a view with given ID
* @see Activity#findViewById(int)
@@ -388,6 +389,7 @@
* will be called to handle shared elements on the <i>launched</i> Activity. This requires
* {@link android.view.Window#FEATURE_CONTENT_TRANSITIONS}.
*
+ * @param activity activity for which to set the callback.
* @param callback Used to manipulate shared element transitions on the launched Activity.
*/
public static void setEnterSharedElementCallback(@NonNull Activity activity,
@@ -407,6 +409,7 @@
* calls will only come when returning from the started Activity.
* This requires {@link android.view.Window#FEATURE_CONTENT_TRANSITIONS}.
*
+ * @param activity activity for which to set the callback.
* @param callback Used to manipulate shared element transitions on the launching Activity.
*/
public static void setExitSharedElementCallback(@NonNull Activity activity,
@@ -642,6 +645,7 @@
/**
* Create {@link DragAndDropPermissionsCompat} object bound to this activity and controlling
* the access permissions for content URIs associated with the {@link android.view.DragEvent}.
+ * @param activity activity for which to request the permission.
* @param dragEvent Drag event to request permission for
* @return The {@link DragAndDropPermissionsCompat} object used to control access to the content
* URIs. {@code null} if no content URIs are associated with the event or if permissions could
@@ -690,6 +694,7 @@
* so that the system can learn appropriate ranking signals linking the activity's
* locus id with the matching shortcut.
*
+ * @param activity activity for which to set locus id.
* @param locusId a unique, stable id that identifies this {@code Activity} instance. LocusId
* is an opaque ID that links this Activity's state to different Android concepts:
* {@link androidx.core.content.pm.ShortcutInfoCompat.Builder#setLocusId(LocusIdCompat)}.
diff --git a/core/core/src/main/java/androidx/core/app/ServiceCompat.java b/core/core/src/main/java/androidx/core/app/ServiceCompat.java
index ae56964..043850e 100644
--- a/core/core/src/main/java/androidx/core/app/ServiceCompat.java
+++ b/core/core/src/main/java/androidx/core/app/ServiceCompat.java
@@ -180,6 +180,7 @@
/**
* Remove the passed service from foreground state, allowing it to be killed if
* more memory is needed.
+ * @param service service to remove.
* @param flags Additional behavior options: {@link #STOP_FOREGROUND_REMOVE},
* {@link #STOP_FOREGROUND_DETACH}.
* @see Service#startForeground(int, Notification)
diff --git a/core/core/src/main/java/androidx/core/content/ContentResolverCompat.java b/core/core/src/main/java/androidx/core/content/ContentResolverCompat.java
index d615a01..ff0ffae 100644
--- a/core/core/src/main/java/androidx/core/content/ContentResolverCompat.java
+++ b/core/core/src/main/java/androidx/core/content/ContentResolverCompat.java
@@ -53,6 +53,7 @@
* </ul>
* </p>
*
+ * @param resolver resolver to use for the query.
* @param uri The URI, using the content:// scheme, for the content to
* retrieve.
* @param projection A list of which columns to return. Passing null will
diff --git a/core/core/src/main/java/androidx/core/content/ContextCompat.java b/core/core/src/main/java/androidx/core/content/ContextCompat.java
index d283059..be0c7a3 100644
--- a/core/core/src/main/java/androidx/core/content/ContextCompat.java
+++ b/core/core/src/main/java/androidx/core/content/ContextCompat.java
@@ -514,6 +514,7 @@
* Starting in {@link Build.VERSION_CODES#LOLLIPOP}, the
* returned drawable will be styled for the specified Context's theme.
*
+ * @param context context to use for getting the drawable.
* @param id The desired resource identifier, as generated by the aapt tool.
* This integer encodes the package, type, and resource entry.
* The value 0 is an invalid identifier.
@@ -549,6 +550,7 @@
* Starting in {@link Build.VERSION_CODES#M}, the returned
* color state list will be styled for the specified Context's theme.
*
+ * @param context context to use for getting the color state list.
* @param id The desired resource identifier, as generated by the aapt
* tool. This integer encodes the package, type, and resource
* entry. The value 0 is an invalid identifier.
@@ -568,6 +570,7 @@
* Starting in {@link Build.VERSION_CODES#M}, the returned
* color will be styled for the specified Context's theme.
*
+ * @param context context to use for getting the color.
* @param id The desired resource identifier, as generated by the aapt
* tool. This integer encodes the package, type, and resource
* entry. The value 0 is an invalid identifier.
@@ -588,6 +591,7 @@
/**
* Determine whether <em>you</em> have been granted a particular permission.
*
+ * @param context context for which to check the permission.
* @param permission The name of the permission being checked.
* @return {@link PackageManager#PERMISSION_GRANTED} if you have the
* permission, or {@link PackageManager#PERMISSION_DENIED} if not.
diff --git a/core/core/src/main/java/androidx/core/content/pm/ShortcutManagerCompat.java b/core/core/src/main/java/androidx/core/content/pm/ShortcutManagerCompat.java
index ea50f63..f8d72df 100644
--- a/core/core/src/main/java/androidx/core/content/pm/ShortcutManagerCompat.java
+++ b/core/core/src/main/java/androidx/core/content/pm/ShortcutManagerCompat.java
@@ -176,6 +176,7 @@
*
* <p>Use {@link android.app.PendingIntent#getIntentSender()} to create a {@link IntentSender}.
*
+ * @param context context to use for the request.
* @param shortcut new shortcut to pin
* @param callback if not null, this intent will be sent when the shortcut is pinned
*
@@ -227,6 +228,7 @@
* <p>This should be used by an Activity to set result in response to
* {@link Intent#ACTION_CREATE_SHORTCUT}.
*
+ * @param context context to use for the intent.
* @param shortcut new shortcut to pin
* @return the intent that should be set as the result for the calling activity
*
@@ -266,6 +268,7 @@
* method with other flag will be ignored.
* </ul>
*
+ * @param context context to use for the shortcuts.
* @return list of {@link ShortcutInfoCompat}s that match the flag.
*
* <p>At least one of the {@code MATCH} flags should be set. Otherwise no shortcuts will be
diff --git a/core/core/src/main/java/androidx/core/content/res/ResourcesCompat.java b/core/core/src/main/java/androidx/core/content/res/ResourcesCompat.java
index c8a8317..681aa16 100644
--- a/core/core/src/main/java/androidx/core/content/res/ResourcesCompat.java
+++ b/core/core/src/main/java/androidx/core/content/res/ResourcesCompat.java
@@ -120,6 +120,7 @@
* Prior to API level 21, the theme will not be applied and this method
* simply calls through to {@link Resources#getDrawable(int)}.
*
+ * @param res resources to use for getting the drawable.
* @param id The desired resource identifier, as generated by the aapt
* tool. This integer encodes the package, type, and resource
* entry. The value 0 is an invalid identifier.
@@ -151,6 +152,7 @@
* Prior to API level 21, the theme will not be applied and this method
* calls through to Resources#getDrawableForDensity(int, int).
*
+ * @param res resources to use for getting the drawable.
* @param id The desired resource identifier, as generated by the aapt
* tool. This integer encodes the package, type, and resource
* entry. The value 0 is an invalid identifier.
@@ -183,6 +185,7 @@
* Prior to API level 23, the theme will not be applied and this method
* calls through to {@link Resources#getColor(int)}.
*
+ * @param res resources to use for getting the color.
* @param id The desired resource identifier, as generated by the aapt
* tool. This integer encodes the package, type, and resource
* entry. The value 0 is an invalid identifier.
@@ -208,6 +211,7 @@
* ID. The resource may contain either a single raw color value or a
* complex {@link ColorStateList} holding multiple possible colors.
*
+ * @param res resources to use for getting the color state list.
* @param id The desired resource identifier of a {@link ColorStateList},
* as generated by the aapt tool. This integer encodes the
* package, type, and resource entry. The value 0 is an invalid
@@ -362,6 +366,7 @@
/**
* Retrieve a floating-point value for a particular resource ID.
*
+ * @param res resources to use for getting the value.
* @param id The desired resource identifier, as generated by the aapt
* tool. This integer encodes the package, type, and resource
* entry. The value 0 is an invalid identifier.
diff --git a/core/core/src/main/java/androidx/core/graphics/BitmapCompat.java b/core/core/src/main/java/androidx/core/graphics/BitmapCompat.java
index d8b67a1..b10563e 100644
--- a/core/core/src/main/java/androidx/core/graphics/BitmapCompat.java
+++ b/core/core/src/main/java/androidx/core/graphics/BitmapCompat.java
@@ -75,6 +75,7 @@
* This property is only a suggestion that can be ignored by the
* renderer. It is not guaranteed to have any effect.
*
+ * @param bitmap bitmap for which to set the state.
* @param hasMipMap indicates whether the renderer should attempt
* to use mipmaps
* @see Bitmap#setHasMipMap(boolean)
diff --git a/core/core/src/main/java/androidx/core/graphics/PathUtils.java b/core/core/src/main/java/androidx/core/graphics/PathUtils.java
index 8c88875..d08541d 100644
--- a/core/core/src/main/java/androidx/core/graphics/PathUtils.java
+++ b/core/core/src/main/java/androidx/core/graphics/PathUtils.java
@@ -36,6 +36,8 @@
*
* <em>Note:</em> This method requires API 26 or newer.
*
+ * @param path path to flatten.
+ *
* @see #flatten(Path, float)
*/
@RequiresApi(26)
@@ -49,6 +51,7 @@
*
* <em>Note:</em> This method requires API 26 or newer.
*
+ * @param path path to flatten.
* @param error The acceptable error for a line on the Path. Typically this would be
* 0.5 so that the error is less than half a pixel.
*
diff --git a/core/core/src/main/java/androidx/core/graphics/TypefaceCompat.java b/core/core/src/main/java/androidx/core/graphics/TypefaceCompat.java
index 63bc7fb..0df99eb 100644
--- a/core/core/src/main/java/androidx/core/graphics/TypefaceCompat.java
+++ b/core/core/src/main/java/androidx/core/graphics/TypefaceCompat.java
@@ -315,6 +315,7 @@
* This method is thread safe.
* </p>
*
+ * @param context context to use for the creation.
* @param family An existing {@link Typeface} object. In case of {@code null}, the default
* typeface is used instead.
* @param weight The desired weight to be drawn.
diff --git a/core/core/src/main/java/androidx/core/graphics/drawable/DrawableCompat.java b/core/core/src/main/java/androidx/core/graphics/drawable/DrawableCompat.java
index d738031..3d01b86 100644
--- a/core/core/src/main/java/androidx/core/graphics/drawable/DrawableCompat.java
+++ b/core/core/src/main/java/androidx/core/graphics/drawable/DrawableCompat.java
@@ -119,6 +119,10 @@
* different from the drawable bounds.
*
* @param drawable The Drawable against which to invoke the method.
+ * @param left position in pixels of the left bound
+ * @param top position in pixels of the top bound
+ * @param right position in pixels of the right bound
+ * @param bottom position in pixels of the bottom bound
*/
public static void setHotspotBounds(@NonNull Drawable drawable, int left, int top,
int right, int bottom) {
@@ -262,6 +266,7 @@
/**
* Inflate this Drawable from an XML resource optionally styled by a theme.
*
+ * @param drawable drawable to inflate.
* @param res Resources used to resolve attribute values
* @param parser XML parser from which to inflate this Drawable
* @param attrs Base set of attribute values
@@ -351,6 +356,7 @@
* layout direction, as the Drawable has no capacity to do the resolution on
* its own.
*
+ * @param drawable drawable for which to set the layout direction.
* @param layoutDirection the resolved layout direction for the drawable,
* either {@link ViewCompat#LAYOUT_DIRECTION_LTR}
* or {@link ViewCompat#LAYOUT_DIRECTION_RTL}
diff --git a/core/core/src/main/java/androidx/core/os/HandlerCompat.java b/core/core/src/main/java/androidx/core/os/HandlerCompat.java
index 3ca278f4..3106865 100644
--- a/core/core/src/main/java/androidx/core/os/HandlerCompat.java
+++ b/core/core/src/main/java/androidx/core/os/HandlerCompat.java
@@ -113,6 +113,7 @@
* </ul>
*
* @param looper the Looper that the new Handler should be bound to
+ * @param callback callback to send events to
* @return a new async Handler instance
* @see Handler#createAsync(Looper, Handler.Callback)
*/
@@ -162,6 +163,7 @@
* <b>The time-base is {@link android.os.SystemClock#uptimeMillis}.</b>
* Time spent in deep sleep will add an additional delay to execution.
*
+ * @param handler handler to use for posting the runnable.
* @param r The Runnable that will be executed.
* @param token An instance which can be used to cancel {@code r} via
* {@link Handler#removeCallbacksAndMessages}.
diff --git a/core/core/src/main/java/androidx/core/os/MessageCompat.java b/core/core/src/main/java/androidx/core/os/MessageCompat.java
index 7340ab2..5b40799 100644
--- a/core/core/src/main/java/androidx/core/os/MessageCompat.java
+++ b/core/core/src/main/java/androidx/core/os/MessageCompat.java
@@ -64,6 +64,7 @@
* <p>
* This API has no effect prior to API 16.
*
+ * @param message message for this to set the mode.
* @param async True if the message is asynchronous.
*
* @see #isAsynchronous(Message)
diff --git a/core/core/src/main/java/androidx/core/provider/DocumentsContractCompat.java b/core/core/src/main/java/androidx/core/provider/DocumentsContractCompat.java
index 2938434..3765bfc 100644
--- a/core/core/src/main/java/androidx/core/provider/DocumentsContractCompat.java
+++ b/core/core/src/main/java/androidx/core/provider/DocumentsContractCompat.java
@@ -193,6 +193,7 @@
/**
* Create a new document with given MIME type and display name.
*
+ * @param content the resolver to use to create the document.
* @param parentDocumentUri directory with {@link Document#FLAG_DIR_SUPPORTS_CREATE}
* @param mimeType MIME type of new document
* @param displayName name of new document
@@ -232,6 +233,7 @@
* This method was only added in {@link Build.VERSION_CODES#N}. On versions prior to this,
* this method calls through to {@link DocumentsContract#deleteDocument(ContentResolver, Uri)}.
*
+ * @param content the resolver to use to remove the document.
* @param documentUri document with {@link Document#FLAG_SUPPORTS_REMOVE}
* @param parentDocumentUri parent document of the document to remove.
* @return true if the document was removed successfully.
diff --git a/core/core/src/main/java/androidx/core/text/util/LinkifyCompat.java b/core/core/src/main/java/androidx/core/text/util/LinkifyCompat.java
index 24368ba..0d4edc6 100644
--- a/core/core/src/main/java/androidx/core/text/util/LinkifyCompat.java
+++ b/core/core/src/main/java/androidx/core/text/util/LinkifyCompat.java
@@ -213,6 +213,7 @@
* @param matchFilter The filter that is used to allow the client code
* additional control over which pattern matches are
* to be converted into links.
+ * @param transformFilter Filter to allow the client code to update the link found.
*/
public static void addLinks(@NonNull TextView text, @NonNull Pattern pattern,
@Nullable String scheme, @Nullable MatchFilter matchFilter,
diff --git a/core/core/src/main/java/androidx/core/view/ContentInfoCompat.java b/core/core/src/main/java/androidx/core/view/ContentInfoCompat.java
index e32353e..1f3ffb0 100644
--- a/core/core/src/main/java/androidx/core/view/ContentInfoCompat.java
+++ b/core/core/src/main/java/androidx/core/view/ContentInfoCompat.java
@@ -310,6 +310,7 @@
* <p>Except for the {@link ClipData} items, the returned objects will contain all the same
* metadata as the passed-in {@link ContentInfo}.
*
+ * @param payload payload to add to returned pair.
* @param itemPredicate The predicate to test each {@link ClipData.Item} to determine which
* partition to place it into.
* @return A pair containing the partitioned content. The pair's first object will have the
diff --git a/core/core/src/main/java/androidx/core/view/DragStartHelper.java b/core/core/src/main/java/androidx/core/view/DragStartHelper.java
index 0c6db11..6d86d81 100644
--- a/core/core/src/main/java/androidx/core/view/DragStartHelper.java
+++ b/core/core/src/main/java/androidx/core/view/DragStartHelper.java
@@ -94,6 +94,7 @@
* The newly created helper is not initially attached to the view, {@link #attach} must be
* called explicitly.
* @param view A View
+ * @param listener listener for the drag events.
*/
public DragStartHelper(@NonNull View view, @NonNull OnDragStartListener listener) {
mView = view;
diff --git a/core/core/src/main/java/androidx/core/view/MarginLayoutParamsCompat.java b/core/core/src/main/java/androidx/core/view/MarginLayoutParamsCompat.java
index ca2a214..4237d43 100644
--- a/core/core/src/main/java/androidx/core/view/MarginLayoutParamsCompat.java
+++ b/core/core/src/main/java/androidx/core/view/MarginLayoutParamsCompat.java
@@ -147,6 +147,7 @@
/**
* Set the layout direction.
*
+ * @param lp LayoutParameters for which to set the layout direction.
* @param layoutDirection the layout direction.
* Should be either {@link ViewCompat#LAYOUT_DIRECTION_LTR}
* or {@link ViewCompat#LAYOUT_DIRECTION_RTL}.
diff --git a/core/core/src/main/java/androidx/core/view/MenuItemCompat.java b/core/core/src/main/java/androidx/core/view/MenuItemCompat.java
index 04fdc22..715b9ba 100644
--- a/core/core/src/main/java/androidx/core/view/MenuItemCompat.java
+++ b/core/core/src/main/java/androidx/core/view/MenuItemCompat.java
@@ -298,6 +298,7 @@
* The menu item must be configured to expand or collapse its action view using the flag
* {@link #SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW}.
*
+ * @param item item on which to set the listener.
* @param listener Listener that will respond to expand/collapse events
* @return This menu item instance for call chaining
*
@@ -394,6 +395,7 @@
* <p>
* See {@link Menu} for the menu types that support shortcuts.
*
+ * @param item item for which to set the shortcut.
* @param numericChar The numeric shortcut key. This is the shortcut when
* using a numeric (e.g., 12-key) keyboard.
* @param numericModifiers The numeric modifier associated with the shortcut. It should
@@ -424,6 +426,7 @@
* <p>
* See {@link Menu} for the menu types that support shortcuts.
*
+ * @param item item for which to set the shortcut.
* @param numericChar The numeric shortcut key. This is the shortcut when
* using a 12-key (numeric) keyboard.
* @param numericModifiers The modifier associated with the shortcut. It should
@@ -474,6 +477,7 @@
* <p>
* See {@link Menu} for the menu types that support shortcuts.
*
+ * @param item item for which to set the shortcut.
* @param alphaChar The alphabetic shortcut key. This is the shortcut when
* using a keyboard with alphabetic keys.
* @param alphaModifiers The modifier associated with the shortcut. It should
@@ -522,6 +526,7 @@
* automatically mutate the icon and apply the specified tint and
* tint mode.
*
+ * @param item item for which to set the tint.
* @param tint the tint to apply, may be {@code null} to clear tint
*
* @see #getIconTintList(MenuItem)
@@ -558,6 +563,7 @@
* {@link #setIconTintList(MenuItem, ColorStateList)} to the item's icon. The default mode is
* {@link PorterDuff.Mode#SRC_IN}.
*
+ * @param item item for which to set the tint mode.
* @param tintMode the blending mode used to apply the tint, may be
* {@code null} to clear tint
* @see #setIconTintList(MenuItem, ColorStateList)
diff --git a/core/core/src/main/java/androidx/core/view/MotionEventCompat.java b/core/core/src/main/java/androidx/core/view/MotionEventCompat.java
index 7a35f54..b39a46c 100644
--- a/core/core/src/main/java/androidx/core/view/MotionEventCompat.java
+++ b/core/core/src/main/java/androidx/core/view/MotionEventCompat.java
@@ -548,6 +548,7 @@
/**
* Determines whether the event is from the given source.
+ * @param event motion event for which to check the source.
* @param source The input source to check against.
* @return Whether the event is from the given source.
*/
@@ -559,6 +560,7 @@
* Get axis value for the first pointer index (may be an
* arbitrary pointer identifier).
*
+ * @param event motion event for which to get the value.
* @param axis The axis identifier for the axis value to retrieve.
*
* @see #AXIS_X
@@ -576,6 +578,7 @@
* Returns the value of the requested axis for the given pointer <em>index</em>
* (use {@link #getPointerId(MotionEvent, int)} to find the pointer identifier for this index).
*
+ * @param event motion event for which to get the value.
* @param axis The axis identifier for the axis value to retrieve.
* @param pointerIndex Raw index of pointer to retrieve. Value may be from 0
* (the first pointer that is down) to {@link #getPointerCount(MotionEvent)}-1.
diff --git a/core/core/src/main/java/androidx/core/view/NestedScrollingChildHelper.java b/core/core/src/main/java/androidx/core/view/NestedScrollingChildHelper.java
index 37fe721..652c503 100644
--- a/core/core/src/main/java/androidx/core/view/NestedScrollingChildHelper.java
+++ b/core/core/src/main/java/androidx/core/view/NestedScrollingChildHelper.java
@@ -139,6 +139,7 @@
* @param axes Supported nested scroll axes.
* See {@link androidx.core.view.NestedScrollingChild2#startNestedScroll(int,
* int)}.
+ * @param type type of the scroll.
* @return true if a cooperating parent view was found and nested scrolling started successfully
*/
public boolean startNestedScroll(@ScrollAxis int axes, @NestedScrollType int type) {
diff --git a/core/core/src/main/java/androidx/core/view/ScaleGestureDetectorCompat.java b/core/core/src/main/java/androidx/core/view/ScaleGestureDetectorCompat.java
index 8e83bcf..317f3b4 100644
--- a/core/core/src/main/java/androidx/core/view/ScaleGestureDetectorCompat.java
+++ b/core/core/src/main/java/androidx/core/view/ScaleGestureDetectorCompat.java
@@ -34,6 +34,7 @@
* receive onScale callbacks when the user performs a doubleTap followed by a swipe. Note that
* this is enabled by default if the app targets API 19 and newer.
*
+ * @param scaleGestureDetector detector for which to set the scaling mode.
* @param enabled true to enable quick scaling, false to disable
*
* @deprecated Use {@link #setQuickScaleEnabled(ScaleGestureDetector, boolean)} that takes
@@ -50,6 +51,7 @@
* receive onScale callbacks when the user performs a doubleTap followed by a swipe. Note that
* this is enabled by default if the app targets API 19 and newer.
*
+ * @param scaleGestureDetector detector for which to set the scaling mode.
* @param enabled true to enable quick scaling, false to disable
*/
public static void setQuickScaleEnabled(
diff --git a/core/core/src/main/java/androidx/core/view/ViewCompat.java b/core/core/src/main/java/androidx/core/view/ViewCompat.java
index 5fa5a59..ec39ba4 100644
--- a/core/core/src/main/java/androidx/core/view/ViewCompat.java
+++ b/core/core/src/main/java/androidx/core/view/ViewCompat.java
@@ -56,9 +56,9 @@
import android.view.WindowInsetsController;
import android.view.WindowManager;
import android.view.accessibility.AccessibilityEvent;
-import android.view.accessibility.AccessibilityRecord;
import android.view.accessibility.AccessibilityManager;
import android.view.accessibility.AccessibilityNodeProvider;
+import android.view.accessibility.AccessibilityRecord;
import android.view.autofill.AutofillId;
import android.view.contentcapture.ContentCaptureSession;
import android.view.inputmethod.InputConnection;
@@ -551,7 +551,8 @@
*
* No-op before API 29.
*
- * @param context Context under which this view is created.
+ * @param view view for which to save the data.
+ * @param context Context under which this view is created.
* @param styleable A reference to styleable array R.styleable.Foo
* @param attrs AttributeSet used to construct this view.
* @param t Resolved {@link TypedArray} returned by a call to
@@ -602,16 +603,16 @@
* (allow over-scrolling only if the view content is larger than the container),
* or {@link #OVER_SCROLL_NEVER}.
*
- * @param v The View against which to invoke the method.
+ * @param view The View against which to invoke the method.
* @return This view's over-scroll mode.
* @deprecated Call {@link View#getOverScrollMode()} directly. This method will be
* removed in a future release.
*/
@Deprecated
@OverScroll
- public static int getOverScrollMode(View v) {
+ public static int getOverScrollMode(View view) {
//noinspection ResourceType
- return v.getOverScrollMode();
+ return view.getOverScrollMode();
}
/**
@@ -623,14 +624,14 @@
* Setting the over-scroll mode of a view will have an effect only if the
* view is capable of scrolling.
*
- * @param v The View against which to invoke the method.
+ * @param view The View against which to invoke the method.
* @param overScrollMode The new over-scroll mode for this view.
* @deprecated Call {@link View#setOverScrollMode(int)} directly. This method will be
* removed in a future release.
*/
@Deprecated
- public static void setOverScrollMode(View v, @OverScroll int overScrollMode) {
- v.setOverScrollMode(overScrollMode);
+ public static void setOverScrollMode(View view, @OverScroll int overScrollMode) {
+ view.setOverScrollMode(overScrollMode);
}
/**
@@ -761,6 +762,7 @@
* the delegate to null, an empty delegate will be attached to ensure that other compatibility
* behavior continues to work for this view.
*
+ * @param v view for which to set the delegate.
* @param delegate the object to which accessibility method calls should be
* delegated
* @see AccessibilityDelegateCompat
@@ -801,12 +803,13 @@
* <p>This method is only supported on API >= 26.
* On API 25 and below, it is a no-op</p>
*
+ * @param view view for which to set the hints.
* @param autofillHints The autofill hints to set. If the array is emtpy, {@code null} is set.
* {@link android.R.attr#autofillHints}
*/
- public static void setAutofillHints(@NonNull View v, @Nullable String... autofillHints) {
+ public static void setAutofillHints(@NonNull View view, @Nullable String... autofillHints) {
if (Build.VERSION.SDK_INT >= 26) {
- Api26Impl.setAutofillHints(v, autofillHints);
+ Api26Impl.setAutofillHints(view, autofillHints);
}
}
@@ -1456,6 +1459,7 @@
* <p>
* <em>Note:</em> Prior to API 21, this method will always return {@code true}.
*
+ * @param view view for which to check the state.
* @return Whether the view is exposed for accessibility.
* @see #setImportantForAccessibility(View, int)
* @see #getImportantForAccessibility(View)
@@ -1482,6 +1486,7 @@
* This is intended to be controlled by screen readers. Apps changing focus can confuse
* screen readers, and the resulting behavior can vary by device and screen reader version.
*
+ * @param view view on which to perform the action.
* @param action The action to perform.
* @param arguments Optional action arguments.
* @return Whether the action was performed.
@@ -1723,6 +1728,7 @@
* {@code android:contentDescription}. It is expected that a content description mostly
* remains constant, while a state description updates from time to time.
*
+ * @param view view for which to set the description.
* @param stateDescription the state description of this node.
*
* @throws IllegalStateException If called from an AccessibilityService.
@@ -1745,6 +1751,7 @@
* You must call {@link #setStateDescription(View, CharSequence)} to modify the
* state description.
*
+ * @param view view for which to get the description
* @return the state description
* @see #setStateDescription(View, CharSequence)
*/
@@ -2033,6 +2040,7 @@
* the target class type is unconstrained, an explicit cast may be
* necessary.
*
+ * @param view the view to start the search from.
* @param id the ID to search for
* @return a view with given ID
* @see View#findViewById(int)
@@ -2055,6 +2063,7 @@
* Indicates whether this View is opaque. An opaque View guarantees that it will
* draw all the pixels overlapping its bounds using a fully opaque color.
*
+ * @param view view for which to check the state.
* @return True if this View is guaranteed to be fully opaque, false otherwise.
* @deprecated Use {@link View#isOpaque()} directly. This method will be
* removed in a future release.
@@ -2074,6 +2083,7 @@
*
* @param size How big the view wants to be
* @param measureSpec Constraints imposed by the parent
+ * @param childMeasuredState Size information bit mask for the view's children.
* @return Size information bit mask as defined by
* {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
*
@@ -2468,6 +2478,7 @@
* This effectively positions the object post-layout, in addition to wherever the object's
* layout placed it.
*
+ * @param view view for which to set the translation.
* @param value The horizontal position of this view relative to its left position,
* in pixels.
*
@@ -2483,6 +2494,7 @@
* This effectively positions the object post-layout, in addition to wherever the object's
* layout placed it.
*
+ * @param view view for which to set the translation.
* @param value The vertical position of this view relative to its top position,
* in pixels.
*
@@ -2503,6 +2515,7 @@
* performance implications, especially for large views. It is best to use the alpha property
* sparingly and transiently, as in the case of fading animations.</p>
*
+ * @param view view to set the alpha on.
* @param value The opacity of the view.
*
* @deprecated Use {@link View#setAlpha(float)} directly.
@@ -2518,6 +2531,7 @@
* the x value passed in and the current left property of the view as determined
* by the layout bounds.
*
+ * @param view view to set the position on.
* @param value The visual x position of this view, in pixels.
*
* @deprecated Use {@link View#setX(float)} directly.
@@ -2533,6 +2547,7 @@
* the y value passed in and the current top property of the view as determined by the
* layout bounds.
*
+ * @param view view to set the position on.
* @param value The visual y position of this view, in pixels.
*
* @deprecated Use {@link View#setY(float)} directly.
@@ -2546,6 +2561,7 @@
* Sets the degrees that the view is rotated around the pivot point. Increasing values
* result in clockwise rotation.
*
+ * @param view view to set the rotation on.
* @param value The degrees of rotation.
*
* @deprecated Use {@link View#setRotation(float)} directly.
@@ -2560,6 +2576,7 @@
* Increasing values result in clockwise rotation from the viewpoint of looking down the
* x axis.
*
+ * @param view view to set the rotation on.
* @param value The degrees of X rotation.
*
* @deprecated Use {@link View#setRotationX(float)} directly.
@@ -2574,6 +2591,7 @@
* Increasing values result in counter-clockwise rotation from the viewpoint of looking
* down the y axis.
*
+ * @param view view to set the rotation on.
* @param value The degrees of Y rotation.
*
* @deprecated Use {@link View#setRotationY(float)} directly.
@@ -2587,6 +2605,7 @@
* Sets the amount that the view is scaled in x around the pivot point, as a proportion of
* the view's unscaled width. A value of 1 means that no scaling is applied.
*
+ * @param view view to set the scale on.
* @param value The scaling factor.
*
* @deprecated Use {@link View#setScaleX(float)} directly.
@@ -2600,6 +2619,7 @@
* Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
* the view's unscaled width. A value of 1 means that no scaling is applied.
*
+ * @param view view to set the scale on.
* @param value The scaling factor.
*
* @deprecated Use {@link View#setScaleY(float)} directly.
@@ -2613,6 +2633,7 @@
* The x location of the point around which the view is
* {@link #setRotation(View, float) rotated} and {@link #setScaleX(View, float) scaled}.
*
+ * @param view view for which to get the pivot.
* @deprecated Use {@link View#getPivotX()} directly.
*/
@Deprecated
@@ -2627,6 +2648,7 @@
* Setting this property disables this behavior and causes the view to use only the
* explicitly set pivotX and pivotY values.
*
+ * @param view view for which to set the pivot.
* @param value The x location of the pivot point.
*
* @deprecated Use {@link View#setPivotX(float)} directly.
@@ -2640,6 +2662,7 @@
* The y location of the point around which the view is {@link #setRotation(View,
* float) rotated} and {@link #setScaleY(View, float) scaled}.
*
+ * @param view view for which to get the pivot.
* @return The y location of the pivot point.
*
* @deprecated Use {@link View#getPivotY()} directly.
@@ -2656,6 +2679,7 @@
* Setting this property disables this behavior and causes the view to use only the
* explicitly set pivotX and pivotY values.
*
+ * @param view view for which to set the pivot.
* @param value The y location of the pivot point.
*
* @deprecated Use {@link View#setPivotX(float)} directly.
@@ -2666,6 +2690,7 @@
}
/**
+ * @param view view for which to get the rotation.
* @deprecated Use {@link View#getRotation()} directly.
*/
@Deprecated
@@ -2674,6 +2699,7 @@
}
/**
+ * @param view view for which to get the rotation.
* @deprecated Use {@link View#getRotationX()} directly.
*/
@Deprecated
@@ -2682,6 +2708,7 @@
}
/**
+ * @param view view for which to get the rotation.
* @deprecated Use {@link View#getRotationY()} directly.
*/
@Deprecated
@@ -2690,6 +2717,7 @@
}
/**
+ * @param view view for which to get the scale.
* @deprecated Use {@link View#getScaleX()} directly.
*/
@Deprecated
@@ -2698,6 +2726,7 @@
}
/**
+ * @param view view for which to get the scale.
* @deprecated Use {@link View#getScaleY()} directly.
*/
@Deprecated
@@ -2706,6 +2735,7 @@
}
/**
+ * @param view view for which to get the X.
* @deprecated Use {@link View#getX()} directly.
*/
@Deprecated
@@ -2714,6 +2744,7 @@
}
/**
+ * @param view view for which to get the Y.
* @deprecated Use {@link View#getY()} directly.
*/
@Deprecated
@@ -2722,6 +2753,8 @@
}
/**
+ * @param view view for which to set the elevation.
+ * @param elevation view elevation in pixels.
* Sets the base elevation of this view, in pixels.
*/
public static void setElevation(@NonNull View view, float elevation) {
@@ -2733,6 +2766,7 @@
/**
* The base elevation of this view relative to its parent, in pixels.
*
+ * @param view view for which to get the elevation.
* @return The base depth position of the view, in pixels.
*/
public static float getElevation(@NonNull View view) {
@@ -2744,6 +2778,8 @@
/**
* Sets the depth location of this view relative to its {@link #getElevation(View) elevation}.
+ * @param view view for which to set the translation.
+ * @param translationZ the depth of location of this view relative its elevation.
*/
public static void setTranslationZ(@NonNull View view, float translationZ) {
if (Build.VERSION.SDK_INT >= 21) {
@@ -2754,6 +2790,7 @@
/**
* The depth location of this view relative to its {@link #getElevation(View) elevation}.
*
+ * @param view view for which to get the translation.
* @return The depth of this view relative to its elevation.
*/
public static float getTranslationZ(@NonNull View view) {
@@ -2805,6 +2842,8 @@
/**
* Returns the current system UI visibility that is currently set for the entire window.
*
+ * @param view view for which to get the visibility.
+ *
* @deprecated SystemUiVisibility flags are deprecated. Use
* {@link WindowInsetsController} instead.
*/
@@ -2819,6 +2858,8 @@
/**
* Ask that a new dispatch of {@code View.onApplyWindowInsets(WindowInsets)} be performed. This
* falls back to {@code View.requestFitSystemWindows()} where available.
+ *
+ * @param view view for which to send the request.
*/
public static void requestApplyInsets(@NonNull View view) {
if (Build.VERSION.SDK_INT >= 20) {
@@ -2832,6 +2873,7 @@
* Tells the ViewGroup whether to draw its children in the order defined by the method
* {@code ViewGroup.getChildDrawingOrder(int, int)}.
*
+ * @param viewGroup the ViewGroup for which to set the mode.
* @param enabled true if the order of the children when drawing is determined by
* {@link ViewGroup#getChildDrawingOrder(int, int)}, false otherwise
*
@@ -2865,10 +2907,12 @@
/**
* Returns true if this view should adapt to fit system window insets. This method will always
* return false before API 16 (Jellybean).
+ *
+ * @param view view for which to get the state.
*/
- public static boolean getFitsSystemWindows(@NonNull View v) {
+ public static boolean getFitsSystemWindows(@NonNull View view) {
if (Build.VERSION.SDK_INT >= 16) {
- return Api16Impl.getFitsSystemWindows(v);
+ return Api16Impl.getFitsSystemWindows(view);
}
return false;
}
@@ -2879,6 +2923,10 @@
* the default implementation of {@link View#fitSystemWindows(Rect)} will be
* executed. See that method for more details.
*
+ * @param view view for which to set the state.
+ * @param fitSystemWindows whether or not this view should account for system screen
+ * decorations.
+ *
* @deprecated Use {@link View#setFitsSystemWindows(boolean)} directly.
*/
@Deprecated
@@ -2893,21 +2941,25 @@
* On API 21 and above, also calls <code>StateListAnimator#jumpToCurrentState()</code>
* if there is a StateListAnimator attached to this view.
*
+ * @param view view for which to jump the drawable state.
* @deprecated Use {@link View#jumpDrawablesToCurrentState()} directly.
*/
@Deprecated
- public static void jumpDrawablesToCurrentState(View v) {
- v.jumpDrawablesToCurrentState();
+ public static void jumpDrawablesToCurrentState(View view) {
+ view.jumpDrawablesToCurrentState();
}
/**
* Set an {@link OnApplyWindowInsetsListener} to take over the policy for applying
* window insets to this view. This will only take effect on devices with API 21 or above.
+ *
+ * @param view view on which to the listener.
+ * @param listener listener for the applied window insets.
*/
- public static void setOnApplyWindowInsetsListener(@NonNull final View v,
+ public static void setOnApplyWindowInsetsListener(@NonNull final View view,
final @Nullable OnApplyWindowInsetsListener listener) {
if (Build.VERSION.SDK_INT >= 21) {
- Api21Impl.setOnApplyWindowInsetsListener(v, listener);
+ Api21Impl.setOnApplyWindowInsetsListener(view, listener);
}
}
@@ -2948,6 +3000,7 @@
* The method returns the insets provided minus any that were applied by this view or its
* children.</p>
*
+ * @param view view for which to dispatch the request.
* @param insets Insets to apply
* @return The provided insets minus the insets that were consumed
*/
@@ -2975,6 +3028,7 @@
* <p>
* On devices running API 28 and below, this method has no effect.
*
+ * @param view view for which to set the exclusion rects.
* @param rects A list of precision gesture regions that this view needs to function correctly
* @see View#setSystemGestureExclusionRects
*/
@@ -2991,6 +3045,8 @@
* <p>
* On devices running API 28 and below, this method always returns an empty list.
*
+ * @param view view for which to get the exclusion rects.
+ *
* @see View#getSystemGestureExclusionRects
*/
@NonNull
@@ -3024,6 +3080,7 @@
* Compute insets that should be consumed by this view and the ones that should propagate
* to those under it.
*
+ * @param view view for which insets need to be computed.
* @param insets Insets currently being processed by this View, likely received as a parameter
* to {@link View#onApplyWindowInsets(WindowInsets)}.
* @param outLocalInsets A Rect that will receive the insets that should be consumed
@@ -3084,6 +3141,7 @@
* <p>
* Prior to API 21, this method has no effect.
*
+ * @param view view for which to set the callback.
* @param callback The callback to set, or <code>null</code> to remove the currently installed
* callback
*/
@@ -3299,14 +3357,15 @@
* Controls whether the entire hierarchy under this view will save its
* state when a state saving traversal occurs from its parent.
*
+ * @param view view for which to set the state.
* @param enabled Set to false to <em>disable</em> state saving, or true
* (the default) to allow it.
*
* @deprecated Use {@link View#setSaveFromParentEnabled(boolean)} directly.
*/
@Deprecated
- public static void setSaveFromParentEnabled(View v, boolean enabled) {
- v.setSaveFromParentEnabled(enabled);
+ public static void setSaveFromParentEnabled(View view, boolean enabled) {
+ view.setSaveFromParentEnabled(enabled);
}
/**
@@ -3316,6 +3375,7 @@
* currently interacting with. Activation is a longer-term state that the
* user can move views in and out of.
*
+ * @param view view for which to set the state.
* @param activated true if the view must be activated, false otherwise
*
* @deprecated Use {@link View#setActivated(boolean)} directly.
@@ -3337,6 +3397,7 @@
* ImageView with only the foreground image. The default implementation returns true; subclasses
* should override if they have cases which can be optimized.</p>
*
+ * @param view view for which to get the state.
* @return true if the content in this view might overlap, false otherwise.
*/
public static boolean hasOverlappingRendering(@NonNull View view) {
@@ -3350,6 +3411,7 @@
* Return if the padding as been set through relative values
* {@code View.setPaddingRelative(int, int, int, int)} or thru
*
+ * @param view view for which to get the state.
* @return true if the padding is relative or false if it is not.
*/
public static boolean isPaddingRelative(@NonNull View view) {
@@ -3363,7 +3425,9 @@
* Set the background of the {@code view} to a given Drawable, or remove the background. If the
* background has padding, {@code view}'s padding is set to the background's padding. However,
* when a background is removed, this View's padding isn't touched. If setting the padding is
- * desired, please use{@code setPadding(int, int, int, int)}.
+ * desired, please use {@code setPadding(int, int, int, int)}.
+ * @param view view for which to set the background.
+ * @param background the drawable to use as view background.
*/
public static void setBackground(@NonNull View view, @Nullable Drawable background) {
if (Build.VERSION.SDK_INT >= 16) {
@@ -3478,6 +3542,7 @@
* while a nested scroll is in progress has the effect of
* {@link #stopNestedScroll(View) stopping} the nested scroll.</p>
*
+ * @param view view for which to set the state.
* @param enabled true to enable nested scrolling, false to disable
*
* @see #isNestedScrollingEnabled(View)
@@ -3522,6 +3587,7 @@
* <p>This version of the method just calls {@link #startNestedScroll(View, int, int)} using
* the touch input type.</p>
*
+ * @param view view for which to start the scroll.
* @param axes Flags consisting of a combination of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL}
* and/or {@link ViewCompat#SCROLL_AXIS_VERTICAL}.
* @return true if a cooperative parent was found and nested scrolling has been enabled for
@@ -3544,6 +3610,8 @@
* <p>This version of the method just calls {@link #stopNestedScroll(View, int)} using the
* touch input type.</p>
*
+ * @param view view for which to stop the scroll.
+ *
* @see #startNestedScroll(View, int)
*/
@SuppressWarnings("RedundantCast") // Intentionally invoking interface method.
@@ -3561,6 +3629,7 @@
* <p>This version of the method just calls {@link #hasNestedScrollingParent(View, int)}
* using the touch input type.</p>
*
+ * @param view view for which to check the parent.
* @return whether this view has a nested scrolling parent
*/
@SuppressWarnings("RedundantCast") // Intentionally invoking interface method.
@@ -3581,6 +3650,7 @@
* {@link #dispatchNestedScroll(View, int, int, int, int, int[], int)} using the touch input
* type.</p>
*
+ * @param view view for which to dispatch the scroll.
* @param dxConsumed Horizontal distance in pixels consumed by this view during this scroll step
* @param dyConsumed Vertical distance in pixels consumed by this view during this scroll step
* @param dxUnconsumed Horizontal scroll distance in pixels not consumed by this view
@@ -3612,6 +3682,7 @@
* {@link #dispatchNestedPreScroll(View, int, int, int[], int[], int)} using the touch input
* type.</p>
*
+ * @param view view for which to dispatch the scroll.
* @param dx Horizontal scroll distance in pixels
* @param dy Vertical scroll distance in pixels
* @param consumed Output. If not null, consumed[0] will contain the consumed component of dx
@@ -3664,6 +3735,7 @@
* {@link NestedScrollingParent#onNestedScroll(View, int, int, int, int)}.
* </p>
*
+ * @param view view on which to start the scroll.
* @param axes Flags consisting of a combination of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL}
* and/or {@link ViewCompat#SCROLL_AXIS_VERTICAL}.
* @param type the type of input which cause this scroll event
@@ -3689,6 +3761,7 @@
*
* <p>Calling this method when a nested scroll is not currently in progress is harmless.</p>
*
+ * @param view view for which to stop the scroll.
* @param type the type of input which cause this scroll event
* @see #startNestedScroll(View, int)
*/
@@ -3706,6 +3779,7 @@
* <p>The presence of a nested scrolling parent indicates that this view has initiated
* a nested scroll and it was accepted by an ancestor view further up the view hierarchy.</p>
*
+ * @param view view for which to check the parent.
* @param type the type of input which cause this scroll event
* @return whether this view has a nested scrolling parent
*/
@@ -3736,6 +3810,7 @@
* to be 0, in order to tell how much was actually consumed up the hierarchy of scrolling
* parents.
*
+ * @param view view for which to dispatch the scroll.
* @param dxConsumed Horizontal distance in pixels consumed by this view during this scroll step
* @param dyConsumed Vertical distance in pixels consumed by this view during this scroll step
* @param dxUnconsumed Horizontal scroll distance in pixels not consumed by this view
@@ -3772,6 +3847,7 @@
* {@link #dispatchNestedPreScroll(View, int, int, int[], int[]) dispatchNestedPreScroll} before
* consuming a component of the scroll event themselves.
*
+ * @param view view for which to dispatch the scroll.
* @param dxConsumed Horizontal distance in pixels consumed by this view during this scroll step
* @param dyConsumed Vertical distance in pixels consumed by this view during this scroll step
* @param dxUnconsumed Horizontal scroll distance in pixels not consumed by this view
@@ -3805,6 +3881,7 @@
* scrolling operation to consume some or all of the scroll operation before the child view
* consumes it.</p>
*
+ * @param view view for which to dispatch the scroll.
* @param dx Horizontal scroll distance in pixels
* @param dy Vertical scroll distance in pixels
* @param consumed Output. If not null, consumed[0] will contain the consumed component of dx
@@ -3841,6 +3918,7 @@
* its own content, it can use this method to delegate the fling to its nested scrolling
* parent instead. The parent may optionally consume the fling or observe a child fling.</p>
*
+ * @param view view for which to dispatch the fling.
* @param velocityX Horizontal fling velocity in pixels per second
* @param velocityY Vertical fling velocity in pixels per second
* @param consumed true if the child consumed the fling, false otherwise
@@ -3885,6 +3963,7 @@
* should not offer a horizontal fling velocity to its parents since scrolling along that
* axis is not permitted and carrying velocity along that motion does not make sense.</p>
*
+ * @param view view for which to dispatch the fling.
* @param velocityX Horizontal fling velocity in pixels per second
* @param velocityY Vertical fling velocity in pixels per second
* @return true if a nested scrolling parent consumed the fling
@@ -3953,6 +4032,8 @@
* {@link #setTranslationZ(View, float) translationZ} property plus the current
* {@link #getElevation(View) elevation} property.
*
+ * @param view view for which to get the position.
+ *
* @return The visual z position of this view, in pixels.
*/
public static float getZ(@NonNull View view) {
@@ -3972,6 +4053,7 @@
* <li>API < 21: No-op</li>
* </ul>
*
+ * @param view view for which to set the position.
* @param z The visual z position of this view, in pixels.
*/
public static void setZ(@NonNull View view, float z) {
@@ -3983,6 +4065,7 @@
/**
* Offset this view's vertical location by the specified number of pixels.
*
+ * @param view view that needs to be offset.
* @param offset the number of pixels to offset the view by
*/
public static void offsetTopAndBottom(@NonNull View view, int offset) {
@@ -4031,6 +4114,7 @@
/**
* Offset this view's horizontal location by the specified amount of pixels.
*
+ * @param view view which needs to be offset.
* @param offset the number of pixels to offset the view by
*/
public static void offsetLeftAndRight(@NonNull View view, int offset) {
@@ -4142,6 +4226,7 @@
* <p>
* See {@link #setScrollIndicators(View, int, int)} for usage information.
*
+ * @param view view for which to set the state.
* @param indicators a bitmask of indicators that should be enabled, or
* {@code 0} to disable all indicators
*
@@ -4167,6 +4252,7 @@
* <p>
* For example, to enable the top scroll indicatorExample: {@code setScrollIndicators}
*
+ * @param view view for which to set the state.
* @param indicators the indicator direction, or the logical OR of multiple
* indicator directions. One or more of:
* <ul>
@@ -4177,6 +4263,7 @@
* <li>{@link #SCROLL_INDICATOR_START}</li>
* <li>{@link #SCROLL_INDICATOR_END}</li>
* </ul>
+ * @param mask the mask for scroll indicators.
*
* @see #setScrollIndicators(View, int)
* @see #getScrollIndicators(View)
@@ -4198,6 +4285,8 @@
* To check whether the bottom scroll indicator is enabled, use the value
* of {@code (ViewCompat.getScrollIndicators(view) & ViewCompat.SCROLL_INDICATOR_BOTTOM) != 0}.
*
+ * @param view view for which to get the state.
+ *
* @return a bitmask representing the enabled scroll indicators
*/
public static int getScrollIndicators(@NonNull View view) {
@@ -4209,6 +4298,7 @@
/**
* Set the pointer icon for the current view.
+ * @param view view for which to set the pointer icon.
* @param pointerIcon A PointerIconCompat instance which will be shown when the mouse hovers.
*/
public static void setPointerIcon(@NonNull View view, @Nullable PointerIconCompat pointerIcon) {
@@ -4248,6 +4338,7 @@
* <p>Prior to API 26 this does nothing. Use TooltipCompat class from v7 appcompat library
* for a compatible tooltip implementation.</p>
*
+ * @param view view for which to set the tooltip.
* @param tooltipText the tooltip text
*/
public static void setTooltipText(@NonNull View view, @Nullable CharSequence tooltipText) {
@@ -4306,6 +4397,7 @@
* Sets the ID of the next keyboard navigation cluster root view. Does nothing if {@code view}
* is not a keyboard navigation cluster or if API < 26.
*
+ * @param view view for which to set the ID.
* @param nextClusterForwardId next cluster ID, or {@link View#NO_ID} if the framework
* should decide automatically.
*/
@@ -4319,6 +4411,7 @@
* Returns whether {@code view} is a root of a keyboard navigation cluster. Always returns
* {@code false} on API < 26.
*
+ * @param view view for which to check the cluster.
* @return {@code true} if this view is a root of a cluster, or {@code false} otherwise.
*/
public static boolean isKeyboardNavigationCluster(@NonNull View view) {
@@ -4332,6 +4425,7 @@
* Set whether {@code view} is a root of a keyboard navigation cluster. Does nothing if
* API < 26.
*
+ * @param view view for which to set the cluster.
* @param isCluster {@code true} to mark {@code view} as the root of a cluster, {@code false}
* to unmark.
*/
@@ -4348,6 +4442,7 @@
* Focus gets restored for a view hierarchy when the root of the hierarchy gets added to a
* window or serves as a target of cluster navigation.
*
+ * @param view view for which to check the state.
* @return {@code true} if {@code view} is the default-focus view, {@code false} otherwise.
*/
public static boolean isFocusedByDefault(@NonNull View view) {
@@ -4366,6 +4461,7 @@
* <p>
* Does nothing on API < 26.
*
+ * @param view view for which to set the state.
* @param isFocusedByDefault {@code true} to set {@code view} as the default-focus view,
* {@code false} otherwise.
*/
@@ -4379,6 +4475,7 @@
* Find the nearest keyboard navigation cluster in the specified direction.
* This does not actually give focus to that cluster.
*
+ * @param view view on which to do the search.
* @param currentCluster The starting point of the search. {@code null} means the current
* cluster is not found yet.
* @param direction Direction to look.
@@ -4400,6 +4497,7 @@
* including {@code view} if it is a cluster root itself) to {@code views}. Does nothing
* on API < 26.
*
+ * @param view view on which to make the change.
* @param views collection of keyboard navigation cluster roots found so far.
* @param direction direction to look.
*/
@@ -4415,6 +4513,7 @@
* If the default-focus view cannot be found or if API < 26, this falls back to calling
* {@link View#requestFocus(int)}.
*
+ * @param view view on which to make the change.
* @return {@code true} if {@code view} or one of its descendants took focus, {@code false}
* otherwise.
*/
@@ -4437,6 +4536,7 @@
* this method to return true. A view set to {@link View#FOCUSABLE_AUTO} that resolves
* to focusable will not.</p>
*
+ * @param view view on which to make the change.
* @return {@code true} if the view is focusable or if the view contains a focusable
* view, {@code false} otherwise
*/
@@ -4472,26 +4572,27 @@
* Adds a listener which will receive unhandled {@link KeyEvent}s. This must be called on the
* UI thread.
*
+ * @param view view on which to add the listener.
* @param listener a receiver of unhandled {@link KeyEvent}s.
* @see #removeOnUnhandledKeyEventListener
*/
- @SuppressWarnings("unchecked")
- public static void addOnUnhandledKeyEventListener(@NonNull View v,
+ public static void addOnUnhandledKeyEventListener(@NonNull View view,
final @NonNull OnUnhandledKeyEventListenerCompat listener) {
if (Build.VERSION.SDK_INT >= 28) {
- Api28Impl.addOnUnhandledKeyEventListener(v, listener);
+ Api28Impl.addOnUnhandledKeyEventListener(view, listener);
return;
}
+ @SuppressWarnings("unchecked")
ArrayList<OnUnhandledKeyEventListenerCompat> viewListeners =
(ArrayList<OnUnhandledKeyEventListenerCompat>)
- v.getTag(R.id.tag_unhandled_key_listeners);
+ view.getTag(R.id.tag_unhandled_key_listeners);
if (viewListeners == null) {
viewListeners = new ArrayList<>();
- v.setTag(R.id.tag_unhandled_key_listeners, viewListeners);
+ view.setTag(R.id.tag_unhandled_key_listeners, viewListeners);
}
viewListeners.add(listener);
if (viewListeners.size() == 1) {
- UnhandledKeyEventManager.registerListeningView(v);
+ UnhandledKeyEventManager.registerListeningView(view);
}
}
@@ -4499,23 +4600,24 @@
* Removes a listener which will receive unhandled {@link KeyEvent}s. This must be called on the
* UI thread.
*
+ * @param view view from which to remove the listener.
* @param listener a receiver of unhandled {@link KeyEvent}s.
* @see #addOnUnhandledKeyEventListener
*/
- @SuppressWarnings("unchecked")
- public static void removeOnUnhandledKeyEventListener(@NonNull View v,
+ public static void removeOnUnhandledKeyEventListener(@NonNull View view,
@NonNull OnUnhandledKeyEventListenerCompat listener) {
if (Build.VERSION.SDK_INT >= 28) {
- Api28Impl.removeOnUnhandledKeyEventListener(v, listener);
+ Api28Impl.removeOnUnhandledKeyEventListener(view, listener);
return;
}
+ @SuppressWarnings("unchecked")
ArrayList<OnUnhandledKeyEventListenerCompat> viewListeners =
(ArrayList<OnUnhandledKeyEventListenerCompat>)
- v.getTag(R.id.tag_unhandled_key_listeners);
+ view.getTag(R.id.tag_unhandled_key_listeners);
if (viewListeners != null) {
viewListeners.remove(listener);
if (viewListeners.size() == 0) {
- UnhandledKeyEventManager.unregisterListeningView(v);
+ UnhandledKeyEventManager.unregisterListeningView(view);
}
}
}
diff --git a/core/core/src/main/java/androidx/core/view/ViewGroupCompat.java b/core/core/src/main/java/androidx/core/view/ViewGroupCompat.java
index d892cdd..207e55f 100644
--- a/core/core/src/main/java/androidx/core/view/ViewGroupCompat.java
+++ b/core/core/src/main/java/androidx/core/view/ViewGroupCompat.java
@@ -124,6 +124,7 @@
* Valid values are either {@link #LAYOUT_MODE_CLIP_BOUNDS} or
* {@link #LAYOUT_MODE_OPTICAL_BOUNDS}.
*
+ * @param group ViewGroup for which to set the mode.
* @param mode the layout mode to use during layout operations
*
* @see #getLayoutMode(ViewGroup)
@@ -137,6 +138,7 @@
/**
* Changes whether or not this ViewGroup should be treated as a single entity during
* Activity Transitions.
+ * @param group ViewGroup for which to set the mode.
* @param isTransitionGroup Whether or not the ViewGroup should be treated as a unit
* in Activity transitions. If false, the ViewGroup won't transition,
* only its children. If true, the entire ViewGroup will transition
diff --git a/core/core/src/main/java/androidx/core/view/ViewParentCompat.java b/core/core/src/main/java/androidx/core/view/ViewParentCompat.java
index 7c14bb5..517fc9b8 100644
--- a/core/core/src/main/java/androidx/core/view/ViewParentCompat.java
+++ b/core/core/src/main/java/androidx/core/view/ViewParentCompat.java
@@ -76,6 +76,7 @@
* {@link #onStartNestedScroll(ViewParent, View, View, int, int)} using the touch input type.
* </p>
*
+ * @param parent ViewParent that contains the child view.
* @param child Direct child of this ViewParent containing target
* @param target View that initiated the nested scroll
* @param nestedScrollAxes Flags consisting of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL},
@@ -94,6 +95,7 @@
* {@link #onNestedScrollAccepted(ViewParent, View, View, int, int)} using the touch input type.
* </p>
*
+ * @param parent ViewParent that contains the child view.
* @param child Direct child of this ViewParent containing target
* @param target View that initiated the nested scroll
* @param nestedScrollAxes Flags consisting of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL},
@@ -110,6 +112,7 @@
* <p>This version of the method just calls {@link #onStopNestedScroll(ViewParent, View, int)}
* using the touch input type.</p>
*
+ * @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
*/
public static void onStopNestedScroll(@NonNull ViewParent parent, @NonNull View target) {
@@ -123,6 +126,7 @@
* {@link #onNestedScroll(ViewParent, View, int, int, int, int, int)} using the touch input
* type.
*
+ * @param parent ViewParent that contains the target view.
* @param target The descendent view controlling the nested scroll
* @param dxConsumed Horizontal scroll distance in pixels already consumed by target
* @param dyConsumed Vertical scroll distance in pixels already consumed by target
@@ -150,7 +154,8 @@
* a list within a vertical drawer where the drawer begins dragging once the edge of inner
* scrolling content is reached.</p>
*
- * @param target The descendent view controlling the nested scroll
+ * @param parent ViewParent that contains the target view.
+ * @param target The descendant view controlling the nested scroll
* @param dxConsumed Horizontal scroll distance in pixels already consumed by target
* @param dyConsumed Vertical scroll distance in pixels already consumed by target
* @param dxUnconsumed Horizontal scroll distance in pixels not consumed by target
@@ -170,6 +175,7 @@
* {@link #onNestedPreScroll(ViewParent, View, int, int, int[], int)} using the touch input
* type.</p>
*
+ * @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param dx Horizontal scroll distance in pixels
* @param dy Vertical scroll distance in pixels
@@ -196,6 +202,7 @@
* will receive a call to {@link #onStopNestedScroll(ViewParent, View, int)}.
* </p>
*
+ * @param parent ViewParent that contains the child view.
* @param child Direct child of this ViewParent containing target
* @param target View that initiated the nested scroll
* @param nestedScrollAxes Flags consisting of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL},
@@ -236,6 +243,7 @@
* for the nested scroll. Implementations of this method should always call their superclass's
* implementation of this method if one is present.</p>
*
+ * @param parent ViewParent that contains the child view.
* @param child Direct child of this ViewParent containing target
* @param target View that initiated the nested scroll
* @param nestedScrollAxes Flags consisting of {@link ViewCompat#SCROLL_AXIS_HORIZONTAL},
@@ -276,6 +284,7 @@
* Implementations of this method should always call their superclass's implementation of this
* method if one is present.</p>
*
+ * @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param type the type of input which cause this scroll event
*/
@@ -315,6 +324,7 @@
* a list within a vertical drawer where the drawer begins dragging once the edge of inner
* scrolling content is reached.</p>
*
+ * @param parent ViewParent that contains the target view.
* @param target The descendent view controlling the nested scroll
* @param dxConsumed Horizontal scroll distance in pixels already consumed by target
* @param dyConsumed Vertical scroll distance in pixels already consumed by target
@@ -375,6 +385,7 @@
* This parameter will never be null. Initial values for consumed[0] and consumed[1]
* will always be 0.</p>
*
+ * @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param dx Horizontal scroll distance in pixels
* @param dy Vertical scroll distance in pixels
@@ -415,6 +426,7 @@
* its own content, it can use this method to delegate the fling to its nested scrolling
* parent instead. The parent may optionally consume the fling or observe a child fling.</p>
*
+ * @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param velocityX Horizontal velocity in pixels per second
* @param velocityY Vertical velocity in pixels per second
@@ -453,6 +465,7 @@
* <code>true</code> from this method, the parent indicates that the child should not
* fling its own internal content as well.</p>
*
+ * @param parent ViewParent that contains the target view.
* @param target View that initiated the nested scroll
* @param velocityX Horizontal velocity in pixels per second
* @param velocityY Vertical velocity in pixels per second
@@ -479,6 +492,8 @@
* Notifies a view parent that the accessibility state of one of its
* descendants has changed and that the structure of the subtree is
* different.
+ *
+ * @param parent ViewParent that contains the target view.
* @param child The direct child whose subtree has changed.
* @param source The descendant view that changed.
* @param changeType A bit mask of the types of changes that occurred. One
diff --git a/core/core/src/main/java/androidx/core/view/WindowCompat.java b/core/core/src/main/java/androidx/core/view/WindowCompat.java
index 178501d..4cdb4dd 100644
--- a/core/core/src/main/java/androidx/core/view/WindowCompat.java
+++ b/core/core/src/main/java/androidx/core/view/WindowCompat.java
@@ -78,6 +78,7 @@
* the target class type is unconstrained, an explicit cast may be
* necessary.
*
+ * @param window window in which to find the view.
* @param id the ID to search for
* @return a view with given ID
* @see ViewCompat#requireViewById(View, int)
diff --git a/core/core/src/main/java/androidx/core/view/accessibility/AccessibilityEventCompat.java b/core/core/src/main/java/androidx/core/view/accessibility/AccessibilityEventCompat.java
index fbea1ca..c8cd11d 100644
--- a/core/core/src/main/java/androidx/core/view/accessibility/AccessibilityEventCompat.java
+++ b/core/core/src/main/java/androidx/core/view/accessibility/AccessibilityEventCompat.java
@@ -371,6 +371,7 @@
* Appends an {@link AccessibilityRecord} to the end of
* event records.
*
+ * @param event event for which to append the record.
* @param record The record to append.
*
* @throws IllegalStateException If called from an AccessibilityService.
@@ -386,6 +387,7 @@
/**
* Gets the record at a given index.
*
+ * @param event event for which to get the record.
* @param index The index.
* @return The record at the specified index.
*
@@ -422,6 +424,7 @@
* Sets the bit mask of node tree changes signaled by an
* {@link #TYPE_WINDOW_CONTENT_CHANGED} event.
*
+ * @param event event for which to set the types.
* @param changeTypes The bit mask of change types.
* @throws IllegalStateException If called from an AccessibilityService.
* @see #getContentChangeTypes(AccessibilityEvent)
@@ -459,6 +462,7 @@
/**
* Sets the movement granularity that was traversed.
*
+ * @param event event for which to set the granularity.
* @param granularity The granularity.
*
* @throws IllegalStateException If called from an AccessibilityService.
@@ -495,6 +499,7 @@
* <li>etc.
* </ul>
*
+ * @param event event for which to set the action.
* @param action The action.
* @throws IllegalStateException If called from an AccessibilityService.
* @see AccessibilityNodeInfoCompat#performAction(int)
diff --git a/core/core/src/main/java/androidx/core/view/accessibility/AccessibilityManagerCompat.java b/core/core/src/main/java/androidx/core/view/accessibility/AccessibilityManagerCompat.java
index 0df339c..a5e0a2b 100644
--- a/core/core/src/main/java/androidx/core/view/accessibility/AccessibilityManagerCompat.java
+++ b/core/core/src/main/java/androidx/core/view/accessibility/AccessibilityManagerCompat.java
@@ -161,6 +161,7 @@
* Registers a {@link TouchExplorationStateChangeListener} for changes in
* the global touch exploration state of the system.
*
+ * @param manager AccessibilityManager for which to add the listener.
* @param listener The listener.
* @return True if successfully registered.
*/
@@ -177,6 +178,7 @@
/**
* Unregisters a {@link TouchExplorationStateChangeListener}.
*
+ * @param manager AccessibilityManager for which to remove the listener.
* @param listener The listener.
* @return True if successfully unregistered.
*/
diff --git a/core/core/src/main/java/androidx/core/view/inputmethod/EditorInfoCompat.java b/core/core/src/main/java/androidx/core/view/inputmethod/EditorInfoCompat.java
index fedfc4b..5f89ffe 100644
--- a/core/core/src/main/java/androidx/core/view/inputmethod/EditorInfoCompat.java
+++ b/core/core/src/main/java/androidx/core/view/inputmethod/EditorInfoCompat.java
@@ -207,6 +207,7 @@
* for IMEs to provide many modern features right after the connection setup. We recommend
* calling this method in your implementation.
*
+ * @param editorInfo the editor with which to set the text.
* @param sourceText The complete input text.
*/
public static void setInitialSurroundingText(@NonNull EditorInfo editorInfo,
@@ -227,6 +228,7 @@
* try to include the selected text within {@code subText} to give the system best flexibility
* to choose where and how to trim {@code subText} when necessary.
*
+ * @param editorInfo the editor with which to set the text.
* @param subText The input text. When it was trimmed, {@code subTextStart} must be provided
* correctly.
* @param subTextStart The position that the input text got trimmed. For example, when the
@@ -344,6 +346,7 @@
* Get <var>n</var> characters of text before the current cursor position. May be {@code null}
* when the protocol is not supported.
*
+ * @param editorInfo the editor with which to get the text.
* @param length The expected length of the text.
* @param flags Supplies additional options controlling how the text is returned. May be
* either 0 or {@link InputConnection#GET_TEXT_WITH_STYLES}.
@@ -381,6 +384,7 @@
* Gets the selected text, if any. May be {@code null} when no text is selected or the selected
* text is way too long.
*
+ * @param editorInfo the editor with which to get the text.
* @param flags Supplies additional options controlling how the text is returned. May be
* either 0 or {@link InputConnection#GET_TEXT_WITH_STYLES}.
* @return the text that is currently selected, if any. It could be an empty string when there
@@ -425,6 +429,7 @@
* Get <var>n</var> characters of text after the current cursor position. May be {@code null}
* when the protocol is not supported.
*
+ * @param editorInfo the editor with which to get the text.
* @param length The expected length of the text.
* @param flags Supplies additional options controlling how the text is returned. May be
* either 0 or {@link InputConnection#GET_TEXT_WITH_STYLES}.
diff --git a/core/core/src/main/java/androidx/core/widget/CheckedTextViewCompat.java b/core/core/src/main/java/androidx/core/widget/CheckedTextViewCompat.java
index 95d06da..1e9ab56 100644
--- a/core/core/src/main/java/androidx/core/widget/CheckedTextViewCompat.java
+++ b/core/core/src/main/java/androidx/core/widget/CheckedTextViewCompat.java
@@ -48,6 +48,7 @@
* automatically mutate the drawable and apply the specified tint and tint
* mode using {@link DrawableCompat#setTintList(Drawable, ColorStateList)}.
*
+ * @param textView CheckedTextView for which to apply the tint.
* @param tint the tint to apply, may be {@code null} to clear tint
* @see #setCheckMarkTintList(CheckedTextView, ColorStateList)
*/
@@ -81,6 +82,7 @@
* {@link #setCheckMarkTintList(CheckedTextView, ColorStateList)}} to the check mark drawable.
* The default mode is {@link PorterDuff.Mode#SRC_IN}.
*
+ * @param textView CheckedTextView for which to apply the tint mode.
* @param tintMode the blending mode used to apply the tint, may be
* {@code null} to clear tint
* @see #getCheckMarkTintMode(CheckedTextView)
diff --git a/core/core/src/main/java/androidx/core/widget/CompoundButtonCompat.java b/core/core/src/main/java/androidx/core/widget/CompoundButtonCompat.java
index 40f9d3c..9c45f41 100644
--- a/core/core/src/main/java/androidx/core/widget/CompoundButtonCompat.java
+++ b/core/core/src/main/java/androidx/core/widget/CompoundButtonCompat.java
@@ -50,6 +50,7 @@
* automatically mutate the drawable and apply the specified tint and tint
* mode using {@link DrawableCompat#setTintList(Drawable, ColorStateList)}.
*
+ * @param button button for which to apply the tint.
* @param tint the tint to apply, may be {@code null} to clear tint
*
* @see #setButtonTintList(CompoundButton, ColorStateList)
@@ -84,6 +85,7 @@
* {@link #setButtonTintList(CompoundButton, ColorStateList)}} to the button drawable. The
* default mode is {@link PorterDuff.Mode#SRC_IN}.
*
+ * @param button button for which to apply the tint mode.
* @param tintMode the blending mode used to apply the tint, may be
* {@code null} to clear tint
*
diff --git a/core/core/src/main/java/androidx/core/widget/EdgeEffectCompat.java b/core/core/src/main/java/androidx/core/widget/EdgeEffectCompat.java
index a976eef..3723d24 100644
--- a/core/core/src/main/java/androidx/core/widget/EdgeEffectCompat.java
+++ b/core/core/src/main/java/androidx/core/widget/EdgeEffectCompat.java
@@ -228,6 +228,7 @@
* }
* </pre>
*
+ * @param edgeEffect EdgeEffect to use.
* @param deltaDistance Change in distance since the last call. Values may be 0 (no change) to
* 1.f (full length of the view) or negative values to express change
* back toward the edge reached to initiate the effect.
diff --git a/core/core/src/main/java/androidx/core/widget/ListViewCompat.java b/core/core/src/main/java/androidx/core/widget/ListViewCompat.java
index 1e4175d..66180fd 100644
--- a/core/core/src/main/java/androidx/core/widget/ListViewCompat.java
+++ b/core/core/src/main/java/androidx/core/widget/ListViewCompat.java
@@ -59,6 +59,7 @@
/**
* Check if the items in the list can be scrolled in a certain direction.
*
+ * @param listView ListView for which to check the state.
* @param direction Negative to check scrolling up, positive to check
* scrolling down.
* @return true if the list can be scrolled in the specified direction,
diff --git a/core/core/src/main/java/androidx/core/widget/PopupWindowCompat.java b/core/core/src/main/java/androidx/core/widget/PopupWindowCompat.java
index 59abc4e..415bedd 100644
--- a/core/core/src/main/java/androidx/core/widget/PopupWindowCompat.java
+++ b/core/core/src/main/java/androidx/core/widget/PopupWindowCompat.java
@@ -86,6 +86,7 @@
* Sets whether the popup window should overlap its anchor view when
* displayed as a drop-down.
*
+ * @param popupWindow popup window for which to set the anchor.
* @param overlapAnchor Whether the popup should overlap its anchor.
*/
@SuppressWarnings("JavaReflectionMemberAccess") // Reflective access to private method
@@ -149,6 +150,7 @@
* {@link android.view.WindowManager.LayoutParams#type} therefore the value should match any
* value {@link android.view.WindowManager.LayoutParams#type} accepts.
*
+ * @param popupWindow popup window for which to set the layout type.
* @param layoutType Layout type for this window.
*
* @see android.view.WindowManager.LayoutParams#type
diff --git a/core/core/src/main/java/androidx/core/widget/TextViewCompat.java b/core/core/src/main/java/androidx/core/widget/TextViewCompat.java
index 0e58694..9c5cabf 100644
--- a/core/core/src/main/java/androidx/core/widget/TextViewCompat.java
+++ b/core/core/src/main/java/androidx/core/widget/TextViewCompat.java
@@ -143,6 +143,11 @@
* {@link TextView#setCompoundDrawables} or related methods.
*
* @param textView The TextView against which to invoke the method.
+ * @param start position in pixels of the start bound
+ * @param top position in pixels of the top bound
+ * @param end position in pixels of the end bound
+ * @param bottom position in pixels of the bottom bound
+ *
* @attr name android:drawableStart
* @attr name android:drawableTop
* @attr name android:drawableEnd
@@ -170,6 +175,11 @@
* {@link TextView#setCompoundDrawables} or related methods.
*
* @param textView The TextView against which to invoke the method.
+ * @param start drawable to use at start
+ * @param top drawable to use at top
+ * @param end drawable to use at end
+ * @param bottom drawable to use at bottom
+ *
* @attr name android:drawableStart
* @attr name android:drawableTop
* @attr name android:drawableEnd
@@ -319,6 +329,7 @@
* Specify whether this widget should automatically scale the text to try to perfectly fit
* within the layout bounds by using the default auto-size configuration.
*
+ * @param textView TextView for which to set the mode.
* @param autoSizeTextType the type of auto-size. Must be one of
* {@link TextViewCompat#AUTO_SIZE_TEXT_TYPE_NONE} or
* {@link TextViewCompat#AUTO_SIZE_TEXT_TYPE_UNIFORM}
@@ -340,6 +351,7 @@
* within the layout bounds. If all the configuration params are valid the type of auto-size is
* set to {@link TextViewCompat#AUTO_SIZE_TEXT_TYPE_UNIFORM}.
*
+ * @param textView TextView for which to set the mode.
* @param autoSizeMinTextSize the minimum text size available for auto-size
* @param autoSizeMaxTextSize the maximum text size available for auto-size
* @param autoSizeStepGranularity the auto-size step granularity. It is used in conjunction with
@@ -377,6 +389,7 @@
* within the layout bounds. If at least one value from the <code>presetSizes</code> is valid
* then the type of auto-size is set to {@link TextViewCompat#AUTO_SIZE_TEXT_TYPE_UNIFORM}.
*
+ * @param textView TextView for which to set the mode.
* @param presetSizes an {@code int} array of sizes in pixels
* @param unit the desired dimension unit for the preset sizes above. See {@link TypedValue} for
* the possible dimension units
@@ -702,6 +715,7 @@
* <strong>Note</strong> that if {@code FontMetrics.top} or {@code FontMetrics.ascent} was
* already greater than {@code firstBaselineToTopHeight}, the top padding is not updated.
*
+ * @param textView TextView for which to set the padding.
* @param firstBaselineToTopHeight distance between first baseline to top of the container
* in pixels
*
@@ -747,6 +761,7 @@
* <strong>Note</strong> that if {@code FontMetrics.bottom} or {@code FontMetrics.descent} was
* already greater than {@code lastBaselineToBottomHeight}, the bottom padding is not updated.
*
+ * @param textView TextView for which to set the padding.
* @param lastBaselineToBottomHeight distance between last baseline to bottom of the container
* in pixels
*