Skip to content

Commit ba465a2

Browse files
hunterstichpaulfthomas
authored andcommitted
[Color] Update constructor comments
PiperOrigin-RevId: 548145472
1 parent 674ec44 commit ba465a2

File tree

1 file changed

+0
-30
lines changed

1 file changed

+0
-30
lines changed

lib/java/com/google/android/material/color/utilities/DynamicColor.java

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -120,36 +120,6 @@ public DynamicColor(
120120
this.opacity = null;
121121
}
122122

123-
/**
124-
* A constructor for DynamicColor.
125-
*
126-
* <p>_Strongly_ prefer using one of the convenience constructors. This class is arguably too
127-
* flexible to ensure it can support any scenario. Functional arguments allow overriding without
128-
* risks that come with subclasses.
129-
*
130-
* <p>For example, the default behavior of adjust tone at max contrast to be at a 7.0 ratio with
131-
* its background is principled and matches accessibility guidance. That does not mean it's the
132-
* desired approach for _every_ design system, and every color pairing, always, in every case.
133-
*
134-
* <p>For opaque colors (colors with alpha = 100%).
135-
*
136-
* @param name The name of the dynamic color.
137-
* @param palette Function that provides a TonalPalette given DynamicScheme. A TonalPalette is
138-
* defined by a hue and chroma, so this replaces the need to specify hue/chroma. By providing
139-
* a tonal palette, when contrast adjustments are made, intended chroma can be preserved.
140-
* @param tone Function that provides a tone, given a DynamicScheme.
141-
* @param isBackground Whether this dynamic color is a background, with some other color as the
142-
* foreground.
143-
* @param background The background of the dynamic color (as a function of a `DynamicScheme`), if
144-
* it exists.
145-
* @param secondBackground A second background of the dynamic color (as a function of a
146-
* `DynamicScheme`), if it exists.
147-
* @param contrastCurve A `ContrastCurve` object specifying how its contrast against its
148-
* background should behave in various contrast levels options.
149-
* @param toneDeltaPair A `ToneDeltaPair` object specifying a tone delta constraint between two
150-
* colors. One of them must be the color being constructed.
151-
* @param opacity A function returning the opacity of a color, as a number between 0 and 1.
152-
*/
153123
public DynamicColor(
154124
@NonNull String name,
155125
@NonNull Function<DynamicScheme, TonalPalette> palette,

0 commit comments

Comments
 (0)