Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a comment linking Error Prone's SourceCodeEscapers with the Guava FR #4689

Merged
merged 1 commit into from
Nov 20, 2024
Merged

Add a comment linking Error Prone's SourceCodeEscapers with the Guava FR #4689

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions check_api/src/main/java/com/google/errorprone/util/SourceCodeEscapers.java
View file
Open in desktop
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
Loading