From 007262e0aef80b30034b9ddd702ea252d9a71f4c Mon Sep 17 00:00:00 2001 From: Roozbeh Pournader Date: Fri, 17 Jul 2015 14:00:10 -0700 Subject: [PATCH] Fix default value of stereoReset() in the documentation. The default has been 'true' for eternity in the code. But the documentation was mistakenly saying it was 'false'. Going with the code, since there are people out there relying on the code continuing to work the same way. Bug: 22557371 Change-Id: I6f4e7b2052d0cc30d41e8ccf2b9a5c6111fa0ab7 --- core/java/android/text/BidiFormatter.java | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/core/java/android/text/BidiFormatter.java b/core/java/android/text/BidiFormatter.java index 7ea9da1715c4b..5c088cdd9d3ad 100644 --- a/core/java/android/text/BidiFormatter.java +++ b/core/java/android/text/BidiFormatter.java @@ -173,7 +173,7 @@ public final class BidiFormatter { /** * Specifies whether the BidiFormatter to be built should also "reset" directionality before - * a string being bidi-wrapped, not just after it. The default is false. + * a string being bidi-wrapped, not just after it. The default is true. */ public Builder stereoReset(boolean stereoReset) { if (stereoReset) { @@ -363,12 +363,13 @@ public final class BidiFormatter { * If {@code isolate}, directionally isolates the string so that it does not garble its * surroundings. Currently, this is done by "resetting" the directionality after the string by * appending a trailing Unicode bidi mark matching the context directionality (LRM or RLM) when - * either the overall directionality or the exit directionality of the string is opposite to that - * of the context. If the formatter was built using {@link Builder#stereoReset(boolean)} and - * passing "true" as an argument, also prepends a Unicode bidi mark matching the context - * directionality when either the overall directionality or the entry directionality of the - * string is opposite to that of the context. Note that as opposed to the overall - * directionality, the entry and exit directionalities are determined from the string itself. + * either the overall directionality or the exit directionality of the string is opposite to + * that of the context. Unless the formatter was built using + * {@link Builder#stereoReset(boolean)} with a {@code false} argument, also prepends a Unicode + * bidi mark matching the context directionality when either the overall directionality or the + * entry directionality of the string is opposite to that of the context. Note that as opposed + * to the overall directionality, the entry and exit directionalities are determined from the + * string itself. *

* Does *not* do HTML-escaping. *