DEV/material-components_material-components-android
1
0
Fork 0
mirror of https://github.com/material-components/material-components-android.git synced 2026-02-20 08:39:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

[Javadocs] Remove all broken attr links from Javadocs

Browse Source 
PiperOrigin-RevId: 404246710
This commit is contained in:
dsn5ft 2021-10-19 13:49:24 +00:00 committed by Jeremy Muhia
parent 3668ca7e54
commit 9ae56ceedd
21 changed files with 123 additions and 132 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/java/com/google/android/material/appbar/res/values/attrs.xml
View File

@ -54,7 +54,7 @@
`RecyclerView`, etc.). Default is false. -->
<attr name="liftOnScroll" format="boolean"/>
<!-- The id of the view that the {@link AppBarLayout} should use to determine whether
it should be lifted (i.e., only if {@link R.attr#liftOnScroll} is set to true).
it should be lifted (i.e., only if {@code liftOnScroll} is set to true).
If this id is not set, the {@link AppBarLayout} will use the target view provided
by nested scrolling to determine whether it should be lifted. -->
<attr name="liftOnScrollTargetViewId" format="reference"/>
@ -64,9 +64,9 @@
</declare-styleable>
<declare-styleable name="AppBarLayoutStates">
<!-- @deprecated in favor of {@link R.attr#state_lifted}. -->
<!-- @deprecated in favor of {@code state_lifted}. -->
<attr name="state_collapsed" format="boolean"/>
<!-- @deprecated in favor of {@link R.attr#state_liftable}. -->
<!-- @deprecated in favor of {@code state_liftable}. -->
<attr name="state_collapsible" format="boolean"/>
<!-- State value for {@link com.google.android.material.appbar.AppBarLayout} set when the view
is lifted (elevated). -->

7
lib/java/com/google/android/material/bottomsheet/BottomSheetDialog.java
View File

@ -55,10 +55,9 @@ import com.google.android.material.shape.MaterialShapeDrawable;
* Base class for {@link android.app.Dialog}s styled as a bottom sheet.
*
* <p>Edge to edge window flags are automatically applied if the {@link
* android.R.attr#navigationBarColor} is transparent or translucent and {@link
* R.attr#enableEdgeToEdge} is true. These can be set in the theme that is passed to the
* constructor, or will be taken from the theme of the context (ie. your application or activity
* theme).
* android.R.attr#navigationBarColor} is transparent or translucent and {@code enableEdgeToEdge} is
* true. These can be set in the theme that is passed to the constructor, or will be taken from the
* theme of the context (ie. your application or activity theme).
*
* <p>In edge to edge mode, padding will be added automatically to the top when sliding under the
* status bar. Padding can be applied automatically to the left, right, or bottom if any of

27
lib/java/com/google/android/material/button/MaterialButton.java
View File

@ -83,9 +83,9 @@ import java.util.LinkedHashSet;
* tint color and {@code ?attr/colorOnPrimary} for the text color. For unfilled buttons, this class
* uses {@code ?attr/colorPrimary} for the text color and transparent for the background tint.
*
* <p>Add icons to the start, center, or end of this button using the {@link R.attr#icon app:icon},
* {@link R.attr#iconPadding app:iconPadding}, {@link R.attr#iconTint app:iconTint}, {@link
* R.attr#iconTintMode app:iconTintMode} and {@link R.attr#iconGravity app:iconGravity} attributes.
* <p>Add icons to the start, center, or end of this button using the {@code app:icon}, {@code
* app:iconPadding}, {@code app:iconTint}, {@code app:iconTintMode} and {@code app:iconGravity}
* attributes.
*
* <p>If a start-aligned icon is added to this button, please use a style like one of the ".Icon"
* styles specified in the default MaterialButton styles. The ".Icon" styles adjust padding slightly
@ -93,21 +93,18 @@ import java.util.LinkedHashSet;
* button. If your icon is end-aligned, you cannot use a ".Icon" style and must instead manually
* adjust your padding such that the visual adjustment is mirrored.
*
* <p>Specify background tint using the {@link R.attr#backgroundTint app:backgroundTint} and {@link
* R.attr#backgroundTintMode app:backgroundTintMode} attributes, which accepts either a color or a
* color state list.
* <p>Specify background tint using the {@code app:backgroundTint} and {@code
* app:backgroundTintMode} attributes, which accepts either a color or a color state list.
*
* <p>Ripple color / press state color can be specified using the {@link R.attr#rippleColor
* app:rippleColor} attribute. Ripple opacity will be determined by the Android framework when
* available. Otherwise, this color will be overlaid on the button at a 50% opacity when button is
* pressed.
* <p>Ripple color / press state color can be specified using the {@code app:rippleColor} attribute.
* Ripple opacity will be determined by the Android framework when available. Otherwise, this color
* will be overlaid on the button at a 50% opacity when button is pressed.
*
* <p>Set the stroke color using the {@link R.attr#strokeColor app:strokeColor} attribute, which
* accepts either a color or a color state list. Stroke width can be set using the {@link
* R.attr#strokeWidth app:strokeWidth} attribute.
* <p>Set the stroke color using the {@code app:strokeColor} attribute, which accepts either a color
* or a color state list. Stroke width can be set using the {@code app:strokeWidth} attribute.
*
* <p>Specify the radius of all four corners of the button using the {@link R.attr#cornerRadius
* app:cornerRadius} attribute.
* <p>Specify the radius of all four corners of the button using the {@code app:cornerRadius}
* attribute.
*/
public class MaterialButton extends AppCompatButton implements Checkable, Shapeable {

8
lib/java/com/google/android/material/button/MaterialButtonToggleGroup.java
View File

@ -96,13 +96,13 @@ import java.util.TreeMap;
* methods.
*
* <p>Note: Styling must applied to each child button individually. It is recommended to use the
* {@link R.attr#materialButtonOutlinedStyle} attribute for all child buttons. {@link
* R.attr#materialButtonOutlinedStyle} will most closely match the Material Design guidelines for
* this component, and supports the checked state for child buttons.
* {@code materialButtonOutlinedStyle} attribute for all child buttons. {@code
* materialButtonOutlinedStyle} will most closely match the Material Design guidelines for this
* component, and supports the checked state for child buttons.
*
* <p>Any {@link MaterialButton}s added to this view group are automatically marked as {@code
* checkable}, and by default multiple buttons within the same group can be checked. To enforce that
* only one button can be checked at a time, set the {@link R.attr#singleSelection
* only one button can be checked at a time, set the {@code
* app:singleSelection} attribute to {@code true} on the MaterialButtonToggleGroup or call {@link
* #setSingleSelection(boolean) setSingleSelection(true)}.
*

6
lib/java/com/google/android/material/button/res/values/attrs.xml
View File

@ -52,17 +52,17 @@
<!-- Push icon to the start of the button. -->
<flag name="start" value="0x1"/>
<!-- Push the icon to the start of the text keeping a distance equal to
{@link R.attr#iconPadding} from the text. -->
{@code iconPadding} from the text. -->
<flag name="textStart" value="0x2"/>
<!-- Push icon to the end of the button. -->
<flag name="end" value="0x3"/>
<!-- Push the icon to the end of the text keeping a distance equal to
{@link R.attr#iconPadding} from the text. -->
{@code iconPadding} from the text. -->
<flag name="textEnd" value="0x4"/>
<!-- Push the icon to the top of the button. -->
<flag name="top" value="0x10"/>
<!-- Push the icon to the top of the text keeping a distance equal to
{@link R.attr#iconPadding} from the text. -->
{@code iconPadding} from the text. -->
<flag name="textTop" value="0x20"/>
</attr>
<!-- Tint for icon drawable to display. -->

4
lib/java/com/google/android/material/card/MaterialCardView.java
View File

@ -60,8 +60,8 @@ import com.google.android.material.shape.Shapeable;
* stroked border, regardless of the {@code strokeWidth} value.
*
* <p>Cards implement {@link Checkable}, a default way to switch to {@code android:checked_state} is
* not provided. Clients have to call {@link #setChecked(boolean)}. This shows the {@link
* R.attr#checkedIcon app:checkedIcon} and changes the overlay color.
* not provided. Clients have to call {@link #setChecked(boolean)}. This shows the {@code
* app:checkedIcon} and changes the overlay color.
*
* <p>Cards also have a custom state meant to be used when a card is draggable {@code
* app:dragged_state}. It's used by calling {@link #setDragged(boolean)}. This changes the overlay

15
lib/java/com/google/android/material/chip/Chip.java
View File

@ -93,7 +93,7 @@ import java.util.List;
* accessibility navigation. The main chip and close icon are considered to be separate logical
* sub-views, and contain their own navigation behavior and state.
*
* <p>All attributes from {@link R.styleable#Chip} are supported. Do not use the {@code
* <p>All attributes from {@code R.styleable.Chip} are supported. Do not use the {@code
* android:background} attribute. It will be ignored because Chip manages its own background
* Drawable. Also do not use the {@code android:drawableStart} and {@code android:drawableEnd}
* attributes. They will be ignored because Chip manages its own start ({@code app:chipIcon}) and
@ -103,13 +103,12 @@ import java.util.List;
* <li>{@link android.R.attr#checkable android:checkable} - If true, the chip can be toggled. If
* false, the chip acts like a button.
* <li>{@link android.R.attr#text android:text} - Sets the text of the chip.
* <li>{@link R.attr#chipIcon app:chipIcon} and {@link R.attr#chipIconEnabled app:chipIconEnabled}
* - Sets the icon of the chip. Usually on the left.
* <li>{@link R.attr#checkedIcon app:checkedIcon} and {@link R.attr#checkedIconEnabled
* app:checkedIconEnabled} - Sets a custom icon to use when checked. Usually on the left.
* <li>{@link R.attr#closeIcon app:closeIcon} and {@link R.attr#closeIconEnabled
* app:closeIconEnabled} - Sets a custom icon that the user can click to close. Usually on the
* right.
* <li>{@code app:chipIcon} and {@code app:chipIconEnabled} - Sets the icon of the chip. Usually
* on the left.
* <li>{@code app:checkedIcon} and {@code app:checkedIconEnabled} - Sets a custom icon to use when
* checked. Usually on the left.
* <li>{@code app:closeIcon} and {@code app:closeIconEnabled} - Sets a custom icon that the user
* can click to close. Usually on the right.
* </ul>
*
* <p>You can register a listener on the main chip with {@link #setOnClickListener(OnClickListener)}

10
lib/java/com/google/android/material/chip/ChipDrawable.java
View File

@ -102,12 +102,12 @@ import java.util.Arrays;
* <li>{@link android.R.attr#checkable android:checkable} - If true, the chip can be toggled. If
* false, the chip acts like a button.
* <li>{@link android.R.attr#text android:text} - Sets the text of the chip.
* <li>{@link R.attr#chipIcon app:chipIcon} - Sets the icon of the chip, or use @null to display
* <li>{@code app:chipIcon} - Sets the icon of the chip, or use @null to display no icon. Usually
* on the left.
* <li>{@code app:checkedIcon} - Sets a custom icon to use when checked, or use @null to display
* no icon. Usually on the left.
* <li>{@link R.attr#checkedIcon app:checkedIcon} - Sets a custom icon to use when checked, or
* use @null to display no icon. Usually on the left.
* <li>{@link R.attr#closeIcon app:closeIcon} - Sets a custom icon that the user can click to
* close, or use @null to display no icon. Usually on the right.
* <li>{@code app:closeIcon} - Sets a custom icon that the user can click to close, or use @null
* to display no icon. Usually on the right.
* <li>{@link android.R.attr#ellipsize} - Does not support {@link
* android.text.TextUtils.TruncateAt#MARQUEE} because chip text should not scroll.
* </ul>

12
lib/java/com/google/android/material/chip/ChipGroup.java
View File

@ -44,14 +44,14 @@ import java.util.List;
/**
* A ChipGroup is used to hold multiple {@link Chip}s. By default, the chips are reflowed across
* multiple lines. Set the {@link R.attr#singleLine app:singleLine} attribute to constrain the chips
* to a single horizontal line. If you do so, you'll usually want to wrap this ChipGroup in a {@link
* multiple lines. Set the {@code app:singleLine} attribute to constrain the chips to a single
* horizontal line. If you do so, you'll usually want to wrap this ChipGroup in a {@link
* android.widget.HorizontalScrollView}.
*
* <p>ChipGroup also supports a multiple-exclusion scope for a set of chips. When you set the {@link
* R.attr#singleSelection app:singleSelection} attribute, checking one chip that belongs to a chip
* group unchecks any previously checked chip within the same group. The behavior mirrors that of
* {@link android.widget.RadioGroup}.
* <p>ChipGroup also supports a multiple-exclusion scope for a set of chips. When you set the {@code
* app:singleSelection} attribute, checking one chip that belongs to a chip group unchecks any
* previously checked chip within the same group. The behavior mirrors that of {@link
* android.widget.RadioGroup}.
*/
public class ChipGroup extends FlowLayout {

26
lib/java/com/google/android/material/color/DynamicColors.java
View File

@ -51,12 +51,11 @@ public class DynamicColors {
/**
* Applies dynamic colors to all activities with the theme overlay designated by the theme
* attribute {@link R.attr.dynamicColorThemeOverlay} by registering a
* {@link ActivityLifecycleCallbacks} to your application.
* attribute {@code dynamicColorThemeOverlay} by registering a {@link ActivityLifecycleCallbacks}
* to your application.
*
* @see #applyToActivitiesIfAvailable(Application, int, Precondition) for more detailed info and
* examples.
*
* examples.
* @param application The target application.
*/
public static void applyToActivitiesIfAvailable(@NonNull Application application) {
@ -80,12 +79,11 @@ public class DynamicColors {
/**
* Applies dynamic colors to all activities with the theme overlay designated by the theme
* attribute {@link R.attr.dynamicColorThemeOverlay} according to the given precondition by
* registering a {@link ActivityLifecycleCallbacks} to your application.
* attribute {@code dynamicColorThemeOverlay} according to the given precondition by registering a
* {@link ActivityLifecycleCallbacks} to your application.
*
* @see #applyToActivitiesIfAvailable(Application, int, Precondition) for more detailed info and
* examples.
*
* examples.
* @param application The target application.
* @param precondition The precondition to decide if dynamic colors should be applied.
*/
@ -126,7 +124,7 @@ public class DynamicColors {
/**
* Applies dynamic colors to the given activity with the theme overlay designated by the theme
* attribute {@link R.attr.dynamicColorThemeOverlay}.
* attribute {@code dynamicColorThemeOverlay}.
*
* @param activity The target activity.
*/
@ -146,7 +144,7 @@ public class DynamicColors {
/**
* Applies dynamic colors to the given activity with the theme overlay designated by the theme
* attribute {@link R.attr.dynamicColorThemeOverlay} according to the given precondition.
* attribute {@code dynamicColorThemeOverlay} according to the given precondition.
*
* @param activity The target activity.
* @param precondition The precondition to decide if dynamic colors should be applied.
@ -170,11 +168,11 @@ public class DynamicColors {
}
/**
* Wraps the given context with the theme overlay designated by the theme attribute
* {@link R.attr.dynamicColorThemeOverlay}. The returned context can be used to create
* views with dynamic color support.
* Wraps the given context with the theme overlay designated by the theme attribute {@code
* dynamicColorThemeOverlay}. The returned context can be used to create views with dynamic color
* support.
*
* If dynamic color support or the dynamic color theme overlay is not available, the original
* <p>If dynamic color support or the dynamic color theme overlay is not available, the original
* context will be returned.
*
* @param originalContext The original context.

4
lib/java/com/google/android/material/datepicker/CalendarItemStyle.java
View File

@ -36,7 +36,7 @@ import com.google.android.material.shape.MaterialShapeDrawable;
import com.google.android.material.shape.ShapeAppearanceModel;
/**
* Loads and applies {@link R.styleable#MaterialCalendarDay} attributes to {@link TextView}
* Loads and applies {@code R.styleable.MaterialCalendarDay} attributes to {@link TextView}
* instances.
*/
final class CalendarItemStyle {
@ -131,7 +131,7 @@ final class CalendarItemStyle {
backgroundColor, textColor, strokeColor, strokeWidth, itemShape, insets);
}
/** Applies the {@link R.styleable#MaterialCalendarDay} style to the provided {@code item} */
/** Applies the {@code R.styleable.MaterialCalendarDay} style to the provided {@code item} */
void styleItem(@NonNull TextView item) {
MaterialShapeDrawable backgroundDrawable = new MaterialShapeDrawable();
MaterialShapeDrawable shapeMask = new MaterialShapeDrawable();

28
lib/java/com/google/android/material/datepicker/CalendarStyle.java
View File

@ -26,40 +26,40 @@ import com.google.android.material.resources.MaterialAttributes;
import com.google.android.material.resources.MaterialResources;
/**
* Data class for loaded {@link R.styleable#MaterialCalendar} and {@link
* R.styleable#MaterialCalendarItem} attributes.
* Data class for loaded {@code R.styleable.MaterialCalendar} and {@code
* R.styleable.MaterialCalendarItem} attributes.
*/
final class CalendarStyle {
/**
* The {@link R.styleable#MaterialCalendarItem} style for days with no unique characteristics from
* {@link R.styleable#MaterialCalendar_dayStyle}.
* The {@code R.styleable.MaterialCalendarItem} style for days with no unique characteristics from
* {@code R.styleable.MaterialCalendar_dayStyle}.
*/
@NonNull final CalendarItemStyle day;
/**
* The {@link R.styleable#MaterialCalendarItem} style for selected days from {@link
* R.styleable#MaterialCalendar_daySelectedStyle}.
* The {@code R.styleable.MaterialCalendarItem} style for selected days from {@code
* R.styleable.MaterialCalendar_daySelectedStyle}.
*/
@NonNull final CalendarItemStyle selectedDay;
/**
* The {@link R.styleable#MaterialCalendarItem} style for today from {@link
* R.styleable#MaterialCalendar_dayTodayStyle}.
* The {@code R.styleable.MaterialCalendarItem} style for today from {@code
* R.styleable.MaterialCalendar_dayTodayStyle}.
*/
@NonNull final CalendarItemStyle todayDay;
/**
* The {@link R.styleable#MaterialCalendarItem} style for years with no unique characteristics
* from {@link R.styleable#MaterialCalendar_yearStyle}.
* The {@code R.styleable.MaterialCalendarItem} style for years with no unique characteristics
* from {@code R.styleable#MaterialCalendar_yearStyle}.
*/
@NonNull final CalendarItemStyle year;
/**
* The {@link R.styleable#MaterialCalendarItem} style for selected years from {@link
* R.styleable#MaterialCalendar_yearSelectedStyle}.
* The {@code R.styleable.MaterialCalendarItem} style for selected years from {@code
* R.styleable.MaterialCalendar_yearSelectedStyle}.
*/
@NonNull final CalendarItemStyle selectedYear;
/**
* The {@link R.styleable#MaterialCalendarItem} style for today's year from {@link
* R.styleable#MaterialCalendar_yearTodayStyle}.
* The {@code R.styleable.MaterialCalendarItem} style for today's year from {@code
* R.styleable.MaterialCalendar_yearTodayStyle}.
*/
@NonNull final CalendarItemStyle todayYear;

4
lib/java/com/google/android/material/datepicker/DateSelector.java
View File

@ -72,7 +72,7 @@ public interface DateSelector<S> extends Parcelable {
/**
* Returns a list of longs whose time value represents days that should be marked selected.
*
* <p>Uses {@link R.styleable#MaterialCalendar_daySelectedStyle} for styling.
* <p>Uses {@code R.styleable.MaterialCalendar_daySelectedStyle} for styling.
*/
@NonNull
Collection<Long> getSelectedDays();
@ -80,7 +80,7 @@ public interface DateSelector<S> extends Parcelable {
/**
* Returns a list of ranges whose time values represent ranges that should be filled.
*
* <p>Uses {@link R.styleable#MaterialCalendar_rangeFillColor} for styling.
* <p>Uses {@code R.styleable.MaterialCalendar_rangeFillColor} for styling.
*/
@NonNull
Collection<Pair<Long, Long>> getSelectedRanges();

28
lib/java/com/google/android/material/internal/ThemeEnforcement.java
View File

@ -52,13 +52,12 @@ public final class ThemeEnforcement {
* Safely retrieve styled attribute information in this Context's theme, after checking whether
* the theme is compatible with the component's given style.
*
* <p>Set a component's {@link R.attr#enforceMaterialTheme enforceMaterialTheme} attribute to
* <code>true</code> to ensure that the Context's theme inherits from {@link
* R.style#Theme_MaterialComponents Theme.MaterialComponents}. For example, you'll want to do this
* if the component uses a new attribute defined in <code>Theme.MaterialComponents</code> like
* {@link R.attr#colorSecondary colorSecondary}.
* <p>Set a component's {@code enforceMaterialTheme} attribute to <code>true</code> to ensure that
* the Context's theme inherits from {@code Theme.MaterialComponents}. For example, you'll want to
* do this if the component uses a new attribute defined in <code>
* Theme.MaterialComponents</code> like {@code colorSecondary}.
*
* <p>If {@link R.attr#enforceTextAppearance} attribute is set to <code>true</code> and
* <p>If the {@code enforceTextAppearance} attribute is set to <code>true</code> and
* textAppearanceResIndices parameter is specified and has non-negative values, this will also
* check that a valid TextAppearance is set on this component for the text appearance resources
* passed in.
@ -87,18 +86,17 @@ public final class ThemeEnforcement {
* androidx.appcompat.widget.TintTypedArray}, after checking whether the theme is compatible with
* the component's given style.
*
* <p>Set a component's {@link R.attr#enforceMaterialTheme enforceMaterialTheme} attribute to
* <code>true</code> to ensure that the Context's theme inherits from {@link
* R.style#Theme_MaterialComponents Theme.MaterialComponents}. For example, you'll want to do this
* if the component uses a new attribute defined in <code>Theme.MaterialComponents</code> like
* {@link R.attr#colorSecondary colorSecondary}.
* <p>Set a component's {@code enforceMaterialTheme} attribute to <code>true</code> to ensure that
* the Context's theme inherits from {@code Theme.MaterialComponents}. For example, you'll want to
* do this if the component uses a new attribute defined in <code>Theme.MaterialComponents</code>
* like {@code colorSecondary}.
*
* <p>New components should prefer to use {@link #obtainStyledAttributes(Context, AttributeSet,
* int[], int, int, int...)}, and use
* {@link com.google.android.material.resources.MaterialResources}
* as a replacement for the functionality in {@link androidx.appcompat.widget.TintTypedArray}.
* int[], int, int, int...)}, and use {@link
* com.google.android.material.resources.MaterialResources} as a replacement for the functionality
* in {@link androidx.appcompat.widget.TintTypedArray}.
*
* <p>If {@link R.attr#enforceTextAppearance} attribute is set to <code>true</code> and
* <p>If the {@code enforceTextAppearance} attribute is set to <code>true</code> and
* textAppearanceResIndices parameter is specified and has non-negative values, this will also
* check that a valid TextAppearance is set on this component for the text appearance resources
* passed in.

2
lib/java/com/google/android/material/progressindicator/BaseProgressIndicator.java
View File

@ -52,7 +52,7 @@ import java.util.Arrays;
* This class contains the common functions shared in different types of progress indicators. This
* is an abstract class which is not meant for directly use.
*
* <p>With the default style {@link R.style#Widget_MaterialComponents_ProgressIndicator}, 4dp
* <p>With the default style {@code Widget.MaterialComponents.ProgressIndicator}, 4dp
* indicator/track thickness and no animation is used for visibility change. Without customization,
* primaryColor will be used as the indicator color; the indicator color applying disabledAlpha will
* be used as the track color. The following attributes can be used to customize the progress

2
lib/java/com/google/android/material/progressindicator/BaseProgressIndicatorSpec.java
View File

@ -38,7 +38,7 @@ import com.google.android.material.progressindicator.BaseProgressIndicator.ShowA
/**
* This class contains the parameters shared between linear type and circular type. The parameters
* reflect the attributes defined in {@link R.styleable#BaseProgressIndicator}.
* reflect the attributes defined in {@code R.styleable.BaseProgressIndicator}.
*/
public abstract class BaseProgressIndicatorSpec {
/** The thickness of the track and indicator. */

8
lib/java/com/google/android/material/progressindicator/CircularProgressIndicator.java
View File

@ -35,10 +35,10 @@ import java.lang.annotation.RetentionPolicy;
/**
* This class implements the circular type progress indicators.
*
* <p>With the default style {@link R.style#Widget_MaterialComponents_CircularProgressIndicator},
* 4dp indicator/track thickness is used without animation for visibility change. Without
* customization, primaryColor will be used as the indicator color; the track is transparent. The
* following attributes can be used to customize the component's appearance:
* <p>With the default style {@code Widget.MaterialComponents.CircularProgressIndicator}, 4dp
* indicator/track thickness is used without animation for visibility change. Without customization,
* primaryColor will be used as the indicator color; the track is transparent. The following
* attributes can be used to customize the component's appearance:
*
* <ul>
* <li>{@code trackThickness}: the thickness of the indicator and track.

12
lib/java/com/google/android/material/progressindicator/CircularProgressIndicatorSpec.java
View File

@ -34,8 +34,8 @@ import com.google.android.material.progressindicator.CircularProgressIndicator.I
/**
* This class contains the parameters for drawing a circular type progress indicator. The parameters
* reflect the attributes defined in {@link R.styleable#BaseProgressIndicator} and {@link
* R.styleable#CircularProgressIndicator}.
* reflect the attributes defined in {@code R.styleable.BaseProgressIndicator} and {@code
* R.styleable.CircularProgressIndicator}.
*/
public final class CircularProgressIndicatorSpec extends BaseProgressIndicatorSpec {
@ -51,10 +51,10 @@ public final class CircularProgressIndicatorSpec extends BaseProgressIndicatorSp
/**
* Instantiates the spec for {@link CircularProgressIndicator}.
*
* <p>If attributes in {@link R.styleable#CircularProgressIndicator} are missing, the values in
* the default style {@link R.style#Widget_MaterialComponents_CircularProgressIndicator} will be
* loaded. If attributes in {@link R.styleable#BaseProgressIndicator} are missing, the values in
* the default style {@link R.style#Widget_MaterialComponents_ProgressIndicator} will be loaded.
* <p>If attributes in {@code R.styleable.CircularProgressIndicator} are missing, the values in
* the default style {@code Widget.MaterialComponents.CircularProgressIndicator} will be loaded.
* If attributes in {@code R.styleable.BaseProgressIndicator} are missing, the values in the
* default style {@code Widget.MaterialComponents.ProgressIndicator} will be loaded.
*
* @param context Current themed context.
* @param attrs Component's attributes set.

2
lib/java/com/google/android/material/progressindicator/LinearProgressIndicator.java
View File

@ -34,7 +34,7 @@ import java.lang.annotation.RetentionPolicy;
/**
* This class implements the linear type progress indicators.
*
* <p>With the default style {@link R.style#Widget_MaterialComponents_LinearProgressIndicator}, 4dp
* <p>With the default style {@code Widget.MaterialComponents.LinearProgressIndicator}, 4dp
* indicator/track thickness is used without animation is used for visibility change. Without
* customization, primaryColor will be used as the indicator color; the track is the (first)
* indicator color applying the disabledAlpha. The following attributes can be used to customize the

12
lib/java/com/google/android/material/progressindicator/LinearProgressIndicatorSpec.java
View File

@ -31,8 +31,8 @@ import com.google.android.material.progressindicator.LinearProgressIndicator.Ind
/**
* This class contains the parameters for drawing a linear type progress indicator. The parameters
* reflect the attributes defined in {@link R.styleable#BaseProgressIndicator} and {@link
* R.styleable#LinearProgressIndicator}.
* reflect the attributes defined in {@code R.styleable.BaseProgressIndicator} and {@code
* R.styleable.LinearProgressIndicator}.
*/
public final class LinearProgressIndicatorSpec extends BaseProgressIndicatorSpec {
@ -47,10 +47,10 @@ public final class LinearProgressIndicatorSpec extends BaseProgressIndicatorSpec
/**
* Instantiates the spec for {@link LinearProgressIndicator}.
*
* <p>If attributes in {@link R.styleable#LinearProgressIndicator} are missing, the values in the
* default style {@link R.style#Widget_MaterialComponents_LinearProgressIndicator} will be loaded.
* If attributes in {@link R.styleable#BaseProgressIndicator} are missing, the values in the
* default style {@link R.style#Widget_MaterialComponents_ProgressIndicator} will be loaded.
* <p>If attributes in {@code R.styleable.LinearProgressIndicator} are missing, the values in the
* default style {@code Widget.MaterialComponents.LinearProgressIndicator} will be loaded. If
* attributes in {@code R.styleable.BaseProgressIndicator} are missing, the values in the default
* style {@code Widget.MaterialComponents.ProgressIndicator} will be loaded.
*
* @param context Current themed context.
* @param attrs Component's attributes set.

32
lib/javatests/com/google/android/material/theme/ThemeTest.java
View File

@ -88,8 +88,8 @@ public class ThemeTest {
/**
* These are color attribtues that all themes, including bridge themes, should have.
*
* <p>All Light themes should match {@link R.style#Theme_MaterialComponents_Light} and all Dark
* themes should match {@link R.style#Theme_MaterialComponents}.
* <p>All Light themes should match {@code Theme.MaterialComponents.Light} and all Dark themes
* should match {@code Theme.MaterialComponents}.
*/
private static final ImmutableList<Integer> MATERIAL_BRIDGE_COLOR_ATTRIBUTES =
ImmutableList.of(
@ -108,8 +108,8 @@ public class ThemeTest {
* These are color attributes that all full themes should have in addition to {@link
* #MATERIAL_BRIDGE_COLOR_ATTRIBUTES}.
*
* <p>All Light full themes should match {@link R.style#Theme_MaterialComponents_Light} and all
* Dark themes should match {@link R.style#Theme_MaterialComponents}.
* <p>All Light full themes should match {@code Theme.MaterialComponents.Light} and all Dark
* themes should match {@code Theme.MaterialComponents}.
*/
private static final ImmutableList<Integer> MATERIAL_NON_BRIDGE_COLOR_ATTRIBUTES =
ImmutableList.of(
@ -122,8 +122,8 @@ public class ThemeTest {
/**
* There are color attribtues that all theme overlays should have.
*
* <p>All Light theme overlays shold match {@link R.style#Theme_MaterialComponents_Light} and all
* Dark theme overlays should match {@link R.style#Theme_MaterialComponents}.
* <p>All Light theme overlays shold match {@code Theme.MaterialComponents.Light} and all Dark
* theme overlays should match {@code Theme.MaterialComponents}.
*/
private static final ImmutableList<Integer> MATERIAL_OVERLAY_COLOR_ATTRIBUTES =
ImmutableList.of(
@ -137,8 +137,8 @@ public class ThemeTest {
/**
* These are all the color attributes that all full themes should have.
*
* <p>All Light full themes should match {@link R.style#Theme_MaterialComponents_Light} and all
* Dark full themes should match {@link R.style#Theme_MaterialComponents}.
* <p>All Light full themes should match {@code Theme.MaterialComponents.Light} and all Dark full
* themes should match {@code Theme.MaterialComponents}.
*/
private static final ImmutableList<Integer> MATERIAL_FULL_COLOR_ATTRIBUTES =
ImmutableList.<Integer>builder()
@ -214,8 +214,8 @@ public class ThemeTest {
.build();
/**
* These are all the attributes where full themes should match {@link
* R.style#Theme_MaterialComponents} or {@link R.style#Theme_MaterialComponents_Light}.
* These are all the attributes where full themes should match {@code Theme.MaterialComponents} or
* {@code Theme.MaterialComponents.Light}.
*/
private static final ImmutableList<Integer> MATERIAL_FULL_ATTRIBUTES =
ImmutableList.<Integer>builder()
@ -226,8 +226,8 @@ public class ThemeTest {
/**
* These are color attributes that all M3 themes should have.
*
* <p>All M3 Light themes should match {@link R.style#Theme_Material3_Light} and all M3 Dark
* themes should match {@link R.style#Theme_Material3_Dark}.
* <p>All M3 Light themes should match {@code Theme.Material3.Light} and all M3 Dark themes should
* match {@code Theme.Material3.Dark}.
*/
private static final ImmutableList<Integer> M3_ACCENT_COLOR_ATTRIBUTES =
ImmutableList.of(
@ -252,8 +252,8 @@ public class ThemeTest {
/**
* These are color attributes that all themes and theme overlays should have.
*
* <p>All M3 Light themes should match {@link R.style#Theme_Material3_Light} and all M3 Dark
* themes should match {@link R.style#Theme_Material3_Dark}.
* <p>All M3 Light themes should match {@code Theme.Material3.Light} and all M3 Dark themes should
* match {@code Theme.Material3.Dark}.
*/
private static final ImmutableList<Integer> M3_ADDITIONAL_COLOR_ATTRIBUTES =
ImmutableList.of(
@ -384,8 +384,8 @@ public class ThemeTest {
R.attr.toolbarSurfaceStyle);
/**
* These are all the attributes where full themes should match {@link
* R.style#Theme_Material3_Light} or {@link R.style#Theme_Material3_Dark}.
* These are all the attributes where full themes should match {@code Theme.Material3.Light} or
* {@code Theme_Material3_Dark}.
*/
private static final ImmutableList<Integer> M3_FULL_ATTRIBUTES =
ImmutableList.<Integer>builder()