Skip to content

Commit

Permalink
Add a comment linking Error Prone's SourceCodeEscapers with the Guava FR
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 698400764
  • Loading branch information
cushon authored and Error Prone Team committed Nov 20, 2024
1 parent 150334e commit a52662d
Showing 1 changed file with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,14 @@ public static CharEscaper javaCharEscaper() {
* Returns an {@link Escaper} instance that escapes special characters in a string so it can
* safely be included in either a Java text block.
*
* <p>Double quotes are not escaped. If the string contents contain a run of three or more
* consecutive double quotes, additional action is required to make it safe to include in a text
* block.
*
* <p>See: <a href= "https://docs.oracle.com/javase/specs/jls/se21/html/jls-3.html#jls-3.10.6"
* >The Java Language Specification</a> for more details.
*
* <p>The Guava FR for this is: https://github.com/google/guava/issues/7421
*/
public static CharEscaper getJavaTextBlockEscaper() {
return JAVA_TEXT_BLOCK_ESCAPER;
Expand Down

0 comments on commit a52662d

Please sign in to comment.