Skip to content

Commit

Permalink
[Docs] Fix javadoc links
Browse files Browse the repository at this point in the history
Resolves #4333

GIT_ORIGIN_REV_ID=61739e430bcda13086b83015e4054d7e318cd0d5
PiperOrigin-RevId: 700775734
  • Loading branch information
pubiqq authored and paulfthomas committed Dec 2, 2024
1 parent 05fa0ce commit 767f25a
Show file tree
Hide file tree
Showing 10 changed files with 56 additions and 55 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ private interface OnItemSelectedStateChangedListener {
void onItemSelectedStateChanged(Item item);
}

/** The Dagger module for {@link SearchBarRecyclerDemoActivity} dependencies. */
/** The Dagger module for {@link SearchRecyclerDemoActivity} dependencies. */
@dagger.Module
public abstract static class Module {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@ public void onDetachedFromWindow() {
* or calling `dismiss()` from a `BottomSheetDialogFragment`, tapping outside a dialog, etc...
*
* <p>The default animation to dismiss this dialog is a fade-out transition through a
* windowAnimation. Call {@link #setDismissWithAnimation(true)} if you want to utilize the
* BottomSheet animation instead.
* windowAnimation. Call {@link #setDismissWithAnimation(boolean)} with `true`
* if you want to utilize the BottomSheet animation instead.
*
* <p>If this function is called from a swipe down interaction, or dismissWithAnimation is false,
* then keep the default behavior.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -318,8 +318,8 @@ public void onLayoutChildren(Recycler recycler, State state) {
}
}

// Clamp the horizontal scroll offset by the new min and max by pinging the scroll by
// calculator with a 0 delta.
// Clamp the scroll offset by the new min and max by pinging the scroll by calculator
// with a 0 delta.
scrollOffset += calculateShouldScrollBy(0, scrollOffset, minScroll, maxScroll);

// Ensure currentFillStartPosition is valid if the number of items in the adapter has changed.
Expand Down Expand Up @@ -824,8 +824,7 @@ private void updateCurrentKeylineStateForScrollOffset(
*
* @param delta the delta, resulting from a gesture or other event, that the list would like to be
* scrolled by
* @param currentScroll the current horizontal scroll offset that is always between the min and
* max horizontal scroll
* @param currentScroll the current scroll offset that is always between the min and max scroll
* @param minScroll the minimum scroll offset allowed
* @param maxScroll the maximum scroll offset allowed
* @return an int that represents the change that should be applied to the current scroll offset,
Expand Down Expand Up @@ -1122,10 +1121,10 @@ public void onInitializeAccessibilityEvent(@NonNull AccessibilityEvent event) {
/**
* Gets the scroll offset for a position in the adapter.
*
* <p>This will calculate the horizontal scroll offset needed to place a child at {@code
* position}'s center at the start-most focal keyline. The returned value might be less or greater
* than the min and max scroll offsets but this will be clamped in {@link #scrollBy(int, Recycler,
* State)} (Recycler, State)} by {@link #calculateShouldHorizontallyScrollBy(int, int, int, int)}.
* <p>This will calculate the scroll offset needed to place a child at {@code position}'s center
* at the start-most focal keyline. The returned value might be less or greater than
* the min and max scroll offsets but this will be clamped in {@link #scrollBy(int, Recycler,
* State)} (Recycler, State)} by {@link #calculateShouldScrollBy(int, int, int, int)}.
*
* @param position The position to get the scroll offset to.
* @param keylineState The keyline state in which to calculate the scroll offset to.
Expand Down Expand Up @@ -1183,8 +1182,8 @@ public PointF computeScrollVectorForPosition(int targetPosition) {
/**
* Gets the offset needed to scroll to a position from the current scroll offset.
*
* <p>This will calculate the horizontal scroll offset needed to place a child at {@code
* position}'s center at the start-most focal keyline.
* <p>This will calculate the scroll offset needed to place a child at {@code position}'s center
* at the start-most focal keyline.
*/
int getOffsetToScrollToPosition(int position, @NonNull KeylineState keylineState) {
int targetScrollOffset = getScrollOffsetForPosition(position, keylineState);
Expand Down
3 changes: 2 additions & 1 deletion lib/java/com/google/android/material/chip/Chip.java
Original file line number Diff line number Diff line change
Expand Up @@ -1547,8 +1547,8 @@ public void setChipIconSize(float chipIconSize) {
/**
* Returns whether this chip's close icon is visible.
*
* @see id #setCloseIconVisible(boolean)
* @attr ref com.google.android.material.R.styleable#Chip_chipIconSize
* @see #setCloseIconVisible(boolean)
*/
public boolean isCloseIconVisible() {
return chipDrawable != null && chipDrawable.isCloseIconVisible();
Expand All @@ -1575,6 +1575,7 @@ public void setCloseIconVisible(@BoolRes int id) {
*
* @param closeIconVisible This chip's close icon visibility.
* @attr ref com.google.android.material.R.styleable#Chip_closeIconVisible
* @see #isCloseIconVisible()
*/
public void setCloseIconVisible(boolean closeIconVisible) {
if (chipDrawable != null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ final class CalendarItemStyle {
* the selection marker.
*
* <p>The selection marker's size is defined by the {@link
* R.styleable.MaterialCalendarItem#itemShapeAppearance} and {@link
* R.styleable.MaterialCalendarItem#itemShapeAppearanceOverlay}.
* R.styleable#MaterialCalendarItem_itemShapeAppearance} and {@link
* R.styleable#MaterialCalendarItem_itemShapeAppearanceOverlay}.
*/
@NonNull private final Rect insets;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ public void initialize(@NonNull Context context) {}
* provided date.
*
* @param context The context of the day view
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
* @param month The month number (0-11) corresponding to the day view (see {@link
* java.util.Calendar.MONTH})
* java.util.Calendar#MONTH})
* @param day The day of month number corresponding to the day view (see {@link
* java.util.Calendar.DAY_OF_MONTH})
* java.util.Calendar#DAY_OF_MONTH})
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
* will likely look and behave disabled)
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
Expand All @@ -64,11 +64,11 @@ public Drawable getCompoundDrawableLeft(
* provided date.
*
* @param context The context of the day view
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
* @param month The month number (0-11) corresponding to the day view (see {@link
* java.util.Calendar.MONTH})
* java.util.Calendar#MONTH})
* @param day The day of month number corresponding to the day view (see {@link
* java.util.Calendar.DAY_OF_MONTH})
* java.util.Calendar#DAY_OF_MONTH})
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
* will likely look and behave disabled)
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
Expand All @@ -86,11 +86,11 @@ public Drawable getCompoundDrawableTop(
* provided date.
*
* @param context The context of the day view
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
* @param month The month number (0-11) corresponding to the day view (see {@link
* java.util.Calendar.MONTH})
* java.util.Calendar#MONTH})
* @param day The day of month number corresponding to the day view (see {@link
* java.util.Calendar.DAY_OF_MONTH})
* java.util.Calendar#DAY_OF_MONTH})
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
* will likely look and behave disabled)
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
Expand All @@ -108,11 +108,11 @@ public Drawable getCompoundDrawableRight(
* provided date.
*
* @param context The context of the day view
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
* @param month The month number (0-11) corresponding to the day view (see {@link
* java.util.Calendar.MONTH})
* java.util.Calendar#MONTH})
* @param day The day of month number corresponding to the day view (see {@link
* java.util.Calendar.DAY_OF_MONTH})
* java.util.Calendar#DAY_OF_MONTH})
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
* will likely look and behave disabled)
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
Expand All @@ -130,11 +130,11 @@ public Drawable getCompoundDrawableBottom(
* day view corresponding to the provided date.
*
* @param context The context of the day view
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
* @param month The month number (0-11) corresponding to the day view (see {@link
* java.util.Calendar.MONTH})
* java.util.Calendar#MONTH})
* @param day The day of month number corresponding to the day view (see {@link
* java.util.Calendar.DAY_OF_MONTH})
* java.util.Calendar#DAY_OF_MONTH})
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
* will likely look and behave disabled)
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
Expand All @@ -152,11 +152,11 @@ public ColorStateList getBackgroundColor(
* corresponding to the provided date.
*
* @param context The context of the day view
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
* @param month The month number (0-11) corresponding to the day view (see {@link
* java.util.Calendar.MONTH})
* java.util.Calendar#MONTH})
* @param day The day of month number corresponding to the day view (see {@link
* java.util.Calendar.DAY_OF_MONTH})
* java.util.Calendar#DAY_OF_MONTH})
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
* will likely look and behave disabled)
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
Expand All @@ -173,11 +173,11 @@ public ColorStateList getTextColor(
* Override this method to return the day view's content description.
*
* @param context The context of the day view
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
* @param month The month number (0-11) corresponding to the day view (see {@link
* java.util.Calendar.MONTH})
* java.util.Calendar#MONTH})
* @param day The day of month number corresponding to the day view (see {@link
* java.util.Calendar.DAY_OF_MONTH})
* java.util.Calendar#DAY_OF_MONTH})
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
* will likely look and behave disabled)
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import android.graphics.drawable.Drawable;
import android.util.AttributeSet;
import android.view.View;
import android.view.ViewGroup;
import android.view.ViewParent;
import android.widget.ProgressBar;
import androidx.annotation.AttrRes;
Expand Down Expand Up @@ -178,10 +179,10 @@ boolean visibleToUser() {
* <p>This is necessary as before API 24, it is not guaranteed that Views will ever be notified
* about their parent changing. Thus, we don't have a proper point to hook in and re-check {@link
* #isShown()} on parent changes that result from {@link
* android.view.ViewGroup#attachViewToParent(View, int, LayoutParams)}, which *can* change our
* effective visibility. So this method errs on the side of assuming visibility unless we can
* conclusively prove otherwise (but may result in some false positives, if this view ends up
* being attached to a non-visible hierarchy after being detached in a visible state).
* android.view.ViewGroup#attachViewToParent(View, int, ViewGroup.LayoutParams)}, which *can*
* change our effective visibility. So this method errs on the side of assuming visibility unless
* we can conclusively prove otherwise (but may result in some false positives, if this view
* ends up being attached to a non-visible hierarchy after being detached in a visible state).
*/
boolean isEffectivelyVisible() {
View current = this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import android.os.SystemClock;
import android.util.AttributeSet;
import android.view.View;
import android.view.ViewGroup;
import android.view.ViewParent;
import android.widget.ProgressBar;
import androidx.annotation.AttrRes;
Expand Down Expand Up @@ -471,10 +472,10 @@ && getWindowVisibility() == View.VISIBLE
* <p>This is necessary as before API 24, it is not guaranteed that Views will ever be notified
* about their parent changing. Thus, we don't have a proper point to hook in and re-check {@link
* #isShown()} on parent changes that result from {@link
* android.view.ViewGroup#attachViewToParent(View, int, LayoutParams)}, which *can* change our
* effective visibility. So this method errs on the side of assuming visibility unless we can
* conclusively prove otherwise (but may result in some false positives, if this view ends up
* being attached to a non-visible hierarchy after being detached in a visible state).
* android.view.ViewGroup#attachViewToParent(View, int, ViewGroup.LayoutParams)}, which *can*
* change our effective visibility. So this method errs on the side of assuming visibility unless
* we can conclusively prove otherwise (but may result in some false positives, if this view
* ends up being attached to a non-visible hierarchy after being detached in a visible state).
*/
boolean isEffectivelyVisible() {
View current = this;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,7 @@ public int getOpacity() {
}

/**
* A {@link ConstantState} for {@link Ripple}
*
* A {@link ConstantState} for {@link RippleDrawableCompat}
*/
static final class RippleDrawableCompatState extends ConstantState {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3808,9 +3808,9 @@ public int getEndIconMinSize() {
}

/**
* Sets {@link ImageView.ScaleType} for the start icon's ImageButton.
* Sets {@link ScaleType} for the start icon's ImageButton.
*
* @param scaleType {@link ImageView.ScaleType} for the start icon's ImageButton.
* @param scaleType {@link ScaleType} for the start icon's ImageButton.
* @attr ref android.support.design.button.R.styleable#TextInputLayout_startIconScaleType
* @see #getStartIconScaleType()
*/
Expand All @@ -3819,9 +3819,9 @@ public void setStartIconScaleType(@NonNull ScaleType scaleType) {
}

/**
* Returns the {@link ImageView.ScaleType} for the start icon's ImageButton.
* Returns the {@link ScaleType} for the start icon's ImageButton.
*
* @return Returns the {@link ImageView.ScaleType} for the start icon's ImageButton.
* @return Returns the {@link ScaleType} for the start icon's ImageButton.
* @attr ref android.support.design.button.R.styleable#TextInputLayout_startIconScaleType
* @see #setStartIconScaleType(ScaleType)
*/
Expand All @@ -3831,9 +3831,9 @@ public ScaleType getStartIconScaleType() {
}

/**
* Sets {@link ImageView.ScaleType} for the end icon's ImageButton.
* Sets {@link ScaleType} for the end icon's ImageButton.
*
* @param scaleType {@link ImageView.ScaleType} for the end icon's ImageButton.
* @param scaleType {@link ScaleType} for the end icon's ImageButton.
* @attr ref android.support.design.button.R.styleable#TextInputLayout_endIconScaleType
* @see #getEndIconScaleType()
*/
Expand All @@ -3842,9 +3842,9 @@ public void setEndIconScaleType(@NonNull ScaleType scaleType) {
}

/**
* Returns the {@link ImageView.ScaleType} for the end icon's ImageButton.
* Returns the {@link ScaleType} for the end icon's ImageButton.
*
* @return Returns the {@link ImageView.ScaleType} for the end icon's ImageButton.
* @return Returns the {@link ScaleType} for the end icon's ImageButton.
* @attr ref android.support.design.button.R.styleable#TextInputLayout_endIconScaleType
* @see #setEndIconScaleType(ScaleType)
*/
Expand Down

0 comments on commit 767f25a

Please sign in to comment.