Skip to content

Commit 767f25a

Browse files
pubiqqpaulfthomas
authored andcommitted
[Docs] Fix javadoc links
Resolves #4333 GIT_ORIGIN_REV_ID=61739e430bcda13086b83015e4054d7e318cd0d5 PiperOrigin-RevId: 700775734
1 parent 05fa0ce commit 767f25a

File tree

10 files changed

+56
-55
lines changed

10 files changed

+56
-55
lines changed

catalog/java/io/material/catalog/search/SearchRecyclerDemoActivity.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ private interface OnItemSelectedStateChangedListener {
315315
void onItemSelectedStateChanged(Item item);
316316
}
317317

318-
/** The Dagger module for {@link SearchBarRecyclerDemoActivity} dependencies. */
318+
/** The Dagger module for {@link SearchRecyclerDemoActivity} dependencies. */
319319
@dagger.Module
320320
public abstract static class Module {
321321

lib/java/com/google/android/material/bottomsheet/BottomSheetDialog.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,8 +215,8 @@ public void onDetachedFromWindow() {
215215
* or calling `dismiss()` from a `BottomSheetDialogFragment`, tapping outside a dialog, etc...
216216
*
217217
* <p>The default animation to dismiss this dialog is a fade-out transition through a
218-
* windowAnimation. Call {@link #setDismissWithAnimation(true)} if you want to utilize the
219-
* BottomSheet animation instead.
218+
* windowAnimation. Call {@link #setDismissWithAnimation(boolean)} with `true`
219+
* if you want to utilize the BottomSheet animation instead.
220220
*
221221
* <p>If this function is called from a swipe down interaction, or dismissWithAnimation is false,
222222
* then keep the default behavior.

lib/java/com/google/android/material/carousel/CarouselLayoutManager.java

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -318,8 +318,8 @@ public void onLayoutChildren(Recycler recycler, State state) {
318318
}
319319
}
320320

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

325325
// Ensure currentFillStartPosition is valid if the number of items in the adapter has changed.
@@ -824,8 +824,7 @@ private void updateCurrentKeylineStateForScrollOffset(
824824
*
825825
* @param delta the delta, resulting from a gesture or other event, that the list would like to be
826826
* scrolled by
827-
* @param currentScroll the current horizontal scroll offset that is always between the min and
828-
* max horizontal scroll
827+
* @param currentScroll the current scroll offset that is always between the min and max scroll
829828
* @param minScroll the minimum scroll offset allowed
830829
* @param maxScroll the maximum scroll offset allowed
831830
* @return an int that represents the change that should be applied to the current scroll offset,
@@ -1122,10 +1121,10 @@ public void onInitializeAccessibilityEvent(@NonNull AccessibilityEvent event) {
11221121
/**
11231122
* Gets the scroll offset for a position in the adapter.
11241123
*
1125-
* <p>This will calculate the horizontal scroll offset needed to place a child at {@code
1126-
* position}'s center at the start-most focal keyline. The returned value might be less or greater
1127-
* than the min and max scroll offsets but this will be clamped in {@link #scrollBy(int, Recycler,
1128-
* State)} (Recycler, State)} by {@link #calculateShouldHorizontallyScrollBy(int, int, int, int)}.
1124+
* <p>This will calculate the scroll offset needed to place a child at {@code position}'s center
1125+
* at the start-most focal keyline. The returned value might be less or greater than
1126+
* the min and max scroll offsets but this will be clamped in {@link #scrollBy(int, Recycler,
1127+
* State)} (Recycler, State)} by {@link #calculateShouldScrollBy(int, int, int, int)}.
11291128
*
11301129
* @param position The position to get the scroll offset to.
11311130
* @param keylineState The keyline state in which to calculate the scroll offset to.
@@ -1183,8 +1182,8 @@ public PointF computeScrollVectorForPosition(int targetPosition) {
11831182
/**
11841183
* Gets the offset needed to scroll to a position from the current scroll offset.
11851184
*
1186-
* <p>This will calculate the horizontal scroll offset needed to place a child at {@code
1187-
* position}'s center at the start-most focal keyline.
1185+
* <p>This will calculate the scroll offset needed to place a child at {@code position}'s center
1186+
* at the start-most focal keyline.
11881187
*/
11891188
int getOffsetToScrollToPosition(int position, @NonNull KeylineState keylineState) {
11901189
int targetScrollOffset = getScrollOffsetForPosition(position, keylineState);

lib/java/com/google/android/material/chip/Chip.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1547,8 +1547,8 @@ public void setChipIconSize(float chipIconSize) {
15471547
/**
15481548
* Returns whether this chip's close icon is visible.
15491549
*
1550-
* @see id #setCloseIconVisible(boolean)
15511550
* @attr ref com.google.android.material.R.styleable#Chip_chipIconSize
1551+
* @see #setCloseIconVisible(boolean)
15521552
*/
15531553
public boolean isCloseIconVisible() {
15541554
return chipDrawable != null && chipDrawable.isCloseIconVisible();
@@ -1575,6 +1575,7 @@ public void setCloseIconVisible(@BoolRes int id) {
15751575
*
15761576
* @param closeIconVisible This chip's close icon visibility.
15771577
* @attr ref com.google.android.material.R.styleable#Chip_closeIconVisible
1578+
* @see #isCloseIconVisible()
15781579
*/
15791580
public void setCloseIconVisible(boolean closeIconVisible) {
15801581
if (chipDrawable != null) {

lib/java/com/google/android/material/datepicker/CalendarItemStyle.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ final class CalendarItemStyle {
4444
* the selection marker.
4545
*
4646
* <p>The selection marker's size is defined by the {@link
47-
* R.styleable.MaterialCalendarItem#itemShapeAppearance} and {@link
48-
* R.styleable.MaterialCalendarItem#itemShapeAppearanceOverlay}.
47+
* R.styleable#MaterialCalendarItem_itemShapeAppearance} and {@link
48+
* R.styleable#MaterialCalendarItem_itemShapeAppearanceOverlay}.
4949
*/
5050
@NonNull private final Rect insets;
5151

lib/java/com/google/android/material/datepicker/DayViewDecorator.java

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,11 @@ public void initialize(@NonNull Context context) {}
4242
* provided date.
4343
*
4444
* @param context The context of the day view
45-
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
45+
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
4646
* @param month The month number (0-11) corresponding to the day view (see {@link
47-
* java.util.Calendar.MONTH})
47+
* java.util.Calendar#MONTH})
4848
* @param day The day of month number corresponding to the day view (see {@link
49-
* java.util.Calendar.DAY_OF_MONTH})
49+
* java.util.Calendar#DAY_OF_MONTH})
5050
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
5151
* will likely look and behave disabled)
5252
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
@@ -64,11 +64,11 @@ public Drawable getCompoundDrawableLeft(
6464
* provided date.
6565
*
6666
* @param context The context of the day view
67-
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
67+
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
6868
* @param month The month number (0-11) corresponding to the day view (see {@link
69-
* java.util.Calendar.MONTH})
69+
* java.util.Calendar#MONTH})
7070
* @param day The day of month number corresponding to the day view (see {@link
71-
* java.util.Calendar.DAY_OF_MONTH})
71+
* java.util.Calendar#DAY_OF_MONTH})
7272
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
7373
* will likely look and behave disabled)
7474
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
@@ -86,11 +86,11 @@ public Drawable getCompoundDrawableTop(
8686
* provided date.
8787
*
8888
* @param context The context of the day view
89-
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
89+
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
9090
* @param month The month number (0-11) corresponding to the day view (see {@link
91-
* java.util.Calendar.MONTH})
91+
* java.util.Calendar#MONTH})
9292
* @param day The day of month number corresponding to the day view (see {@link
93-
* java.util.Calendar.DAY_OF_MONTH})
93+
* java.util.Calendar#DAY_OF_MONTH})
9494
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
9595
* will likely look and behave disabled)
9696
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
@@ -108,11 +108,11 @@ public Drawable getCompoundDrawableRight(
108108
* provided date.
109109
*
110110
* @param context The context of the day view
111-
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
111+
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
112112
* @param month The month number (0-11) corresponding to the day view (see {@link
113-
* java.util.Calendar.MONTH})
113+
* java.util.Calendar#MONTH})
114114
* @param day The day of month number corresponding to the day view (see {@link
115-
* java.util.Calendar.DAY_OF_MONTH})
115+
* java.util.Calendar#DAY_OF_MONTH})
116116
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
117117
* will likely look and behave disabled)
118118
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
@@ -130,11 +130,11 @@ public Drawable getCompoundDrawableBottom(
130130
* day view corresponding to the provided date.
131131
*
132132
* @param context The context of the day view
133-
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
133+
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
134134
* @param month The month number (0-11) corresponding to the day view (see {@link
135-
* java.util.Calendar.MONTH})
135+
* java.util.Calendar#MONTH})
136136
* @param day The day of month number corresponding to the day view (see {@link
137-
* java.util.Calendar.DAY_OF_MONTH})
137+
* java.util.Calendar#DAY_OF_MONTH})
138138
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
139139
* will likely look and behave disabled)
140140
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
@@ -152,11 +152,11 @@ public ColorStateList getBackgroundColor(
152152
* corresponding to the provided date.
153153
*
154154
* @param context The context of the day view
155-
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
155+
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
156156
* @param month The month number (0-11) corresponding to the day view (see {@link
157-
* java.util.Calendar.MONTH})
157+
* java.util.Calendar#MONTH})
158158
* @param day The day of month number corresponding to the day view (see {@link
159-
* java.util.Calendar.DAY_OF_MONTH})
159+
* java.util.Calendar#DAY_OF_MONTH})
160160
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
161161
* will likely look and behave disabled)
162162
* @param selected Boolean for whether the day view is in a selected state (if selected, the day
@@ -173,11 +173,11 @@ public ColorStateList getTextColor(
173173
* Override this method to return the day view's content description.
174174
*
175175
* @param context The context of the day view
176-
* @param year The year number corresponding to the day view (see {@link java.util.Calendar.YEAR})
176+
* @param year The year number corresponding to the day view (see {@link java.util.Calendar#YEAR})
177177
* @param month The month number (0-11) corresponding to the day view (see {@link
178-
* java.util.Calendar.MONTH})
178+
* java.util.Calendar#MONTH})
179179
* @param day The day of month number corresponding to the day view (see {@link
180-
* java.util.Calendar.DAY_OF_MONTH})
180+
* java.util.Calendar#DAY_OF_MONTH})
181181
* @param valid Boolean for whether the day view is in a valid state (if not valid, the day view
182182
* will likely look and behave disabled)
183183
* @param selected Boolean for whether the day view is in a selected state (if selected, the day

lib/java/com/google/android/material/loadingindicator/LoadingIndicator.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import android.graphics.drawable.Drawable;
3131
import android.util.AttributeSet;
3232
import android.view.View;
33+
import android.view.ViewGroup;
3334
import android.view.ViewParent;
3435
import android.widget.ProgressBar;
3536
import androidx.annotation.AttrRes;
@@ -178,10 +179,10 @@ boolean visibleToUser() {
178179
* <p>This is necessary as before API 24, it is not guaranteed that Views will ever be notified
179180
* about their parent changing. Thus, we don't have a proper point to hook in and re-check {@link
180181
* #isShown()} on parent changes that result from {@link
181-
* android.view.ViewGroup#attachViewToParent(View, int, LayoutParams)}, which *can* change our
182-
* effective visibility. So this method errs on the side of assuming visibility unless we can
183-
* conclusively prove otherwise (but may result in some false positives, if this view ends up
184-
* being attached to a non-visible hierarchy after being detached in a visible state).
182+
* android.view.ViewGroup#attachViewToParent(View, int, ViewGroup.LayoutParams)}, which *can*
183+
* change our effective visibility. So this method errs on the side of assuming visibility unless
184+
* we can conclusively prove otherwise (but may result in some false positives, if this view
185+
* ends up being attached to a non-visible hierarchy after being detached in a visible state).
185186
*/
186187
boolean isEffectivelyVisible() {
187188
View current = this;

lib/java/com/google/android/material/progressindicator/BaseProgressIndicator.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import android.os.SystemClock;
3030
import android.util.AttributeSet;
3131
import android.view.View;
32+
import android.view.ViewGroup;
3233
import android.view.ViewParent;
3334
import android.widget.ProgressBar;
3435
import androidx.annotation.AttrRes;
@@ -471,10 +472,10 @@ && getWindowVisibility() == View.VISIBLE
471472
* <p>This is necessary as before API 24, it is not guaranteed that Views will ever be notified
472473
* about their parent changing. Thus, we don't have a proper point to hook in and re-check {@link
473474
* #isShown()} on parent changes that result from {@link
474-
* android.view.ViewGroup#attachViewToParent(View, int, LayoutParams)}, which *can* change our
475-
* effective visibility. So this method errs on the side of assuming visibility unless we can
476-
* conclusively prove otherwise (but may result in some false positives, if this view ends up
477-
* being attached to a non-visible hierarchy after being detached in a visible state).
475+
* android.view.ViewGroup#attachViewToParent(View, int, ViewGroup.LayoutParams)}, which *can*
476+
* change our effective visibility. So this method errs on the side of assuming visibility unless
477+
* we can conclusively prove otherwise (but may result in some false positives, if this view
478+
* ends up being attached to a non-visible hierarchy after being detached in a visible state).
478479
*/
479480
boolean isEffectivelyVisible() {
480481
View current = this;

lib/java/com/google/android/material/ripple/RippleDrawableCompat.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,7 @@ public int getOpacity() {
185185
}
186186

187187
/**
188-
* A {@link ConstantState} for {@link Ripple}
189-
*
188+
* A {@link ConstantState} for {@link RippleDrawableCompat}
190189
*/
191190
static final class RippleDrawableCompatState extends ConstantState {
192191

lib/java/com/google/android/material/textfield/TextInputLayout.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3808,9 +3808,9 @@ public int getEndIconMinSize() {
38083808
}
38093809

38103810
/**
3811-
* Sets {@link ImageView.ScaleType} for the start icon's ImageButton.
3811+
* Sets {@link ScaleType} for the start icon's ImageButton.
38123812
*
3813-
* @param scaleType {@link ImageView.ScaleType} for the start icon's ImageButton.
3813+
* @param scaleType {@link ScaleType} for the start icon's ImageButton.
38143814
* @attr ref android.support.design.button.R.styleable#TextInputLayout_startIconScaleType
38153815
* @see #getStartIconScaleType()
38163816
*/
@@ -3819,9 +3819,9 @@ public void setStartIconScaleType(@NonNull ScaleType scaleType) {
38193819
}
38203820

38213821
/**
3822-
* Returns the {@link ImageView.ScaleType} for the start icon's ImageButton.
3822+
* Returns the {@link ScaleType} for the start icon's ImageButton.
38233823
*
3824-
* @return Returns the {@link ImageView.ScaleType} for the start icon's ImageButton.
3824+
* @return Returns the {@link ScaleType} for the start icon's ImageButton.
38253825
* @attr ref android.support.design.button.R.styleable#TextInputLayout_startIconScaleType
38263826
* @see #setStartIconScaleType(ScaleType)
38273827
*/
@@ -3831,9 +3831,9 @@ public ScaleType getStartIconScaleType() {
38313831
}
38323832

38333833
/**
3834-
* Sets {@link ImageView.ScaleType} for the end icon's ImageButton.
3834+
* Sets {@link ScaleType} for the end icon's ImageButton.
38353835
*
3836-
* @param scaleType {@link ImageView.ScaleType} for the end icon's ImageButton.
3836+
* @param scaleType {@link ScaleType} for the end icon's ImageButton.
38373837
* @attr ref android.support.design.button.R.styleable#TextInputLayout_endIconScaleType
38383838
* @see #getEndIconScaleType()
38393839
*/
@@ -3842,9 +3842,9 @@ public void setEndIconScaleType(@NonNull ScaleType scaleType) {
38423842
}
38433843

38443844
/**
3845-
* Returns the {@link ImageView.ScaleType} for the end icon's ImageButton.
3845+
* Returns the {@link ScaleType} for the end icon's ImageButton.
38463846
*
3847-
* @return Returns the {@link ImageView.ScaleType} for the end icon's ImageButton.
3847+
* @return Returns the {@link ScaleType} for the end icon's ImageButton.
38483848
* @attr ref android.support.design.button.R.styleable#TextInputLayout_endIconScaleType
38493849
* @see #setEndIconScaleType(ScaleType)
38503850
*/

0 commit comments

Comments
 (0)