diff options
| author | 2023-10-16 16:23:44 +0900 | |
|---|---|---|
| committer | 2023-10-18 00:16:28 +0000 | |
| commit | f084a5b8d28e0733995b3b1d519529b1df18b51c (patch) | |
| tree | fddd9fcb7fd58cc5f3f7c1cd778cd14a0255ae66 | |
| parent | 0a8132fb6d238a1b137a2a91636c2ad45b649f86 (diff) | |
Add more comment to LineBreakConfig#reset
Fix: 304697323
Test: N/A
Change-Id: I4c7c0cd7f822a348a65282eac13db3c3947d38a2
| -rw-r--r-- | graphics/java/android/graphics/text/LineBreakConfig.java | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/graphics/java/android/graphics/text/LineBreakConfig.java b/graphics/java/android/graphics/text/LineBreakConfig.java index f5e5803d4796..dc1773bd7290 100644 --- a/graphics/java/android/graphics/text/LineBreakConfig.java +++ b/graphics/java/android/graphics/text/LineBreakConfig.java @@ -39,12 +39,14 @@ public final class LineBreakConfig { /** * No hyphenation preference is specified. * + * <p> * This is a special value of hyphenation preference indicating no hyphenation preference is * specified. When overriding a {@link LineBreakConfig} with another {@link LineBreakConfig} * with {@link Builder#merge(LineBreakConfig)} function, the hyphenation preference of * overridden config will be kept if the hyphenation preference of overriding config is * {@link #HYPHENATION_UNSPECIFIED}. * + * <p> * <pre> * val override = LineBreakConfig.Builder() * .setLineBreakWordStyle(LineBreakConfig.LINE_BREAK_WORD_STYLE_PHRASE) @@ -57,6 +59,7 @@ public final class LineBreakConfig { * // LINE_BREAK_WORD_STYLE_PHRASE for line break word style. * </pre> * + * <p> * This value is resolved to {@link #HYPHENATION_ENABLED} if this value is used for text * layout/rendering. */ @@ -89,6 +92,7 @@ public final class LineBreakConfig { /** * No line break style is specified. * + * <p> * This is a special value of line break style indicating no style value is specified. * When overriding a {@link LineBreakConfig} with another {@link LineBreakConfig} with * {@link Builder#merge(LineBreakConfig)} function, the line break style of overridden config @@ -107,6 +111,7 @@ public final class LineBreakConfig { * // LINE_BREAK_WORD_STYLE_PHRASE for line break word style. * </pre> * + * <p> * This value is resolved to {@link #LINE_BREAK_STYLE_NONE} if this value is used for text * layout/rendering. */ @@ -270,6 +275,8 @@ public final class LineBreakConfig { /** * Resets this builder to the given config state. * + * @param config a config value used for resetting. {@code null} is allowed. If {@code null} + * is passed, all configs are reset to unspecified. * @return This {@code Builder}. * @hide */ |