Improve Encode.forHtmlAttribute docs #72
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
meeque
commented
Apr 18, 2024
| @@ -243,7 +243,7 @@ public static void forHtmlContent(Writer out, String input) | |||
| * | |||
| * <b>Example JSP Usage</b> | |||
| * <pre> | |||
| * <div><%=Encode.forHtmlAttribute(unsafeData)%></div> | |||
| * <input value="<%=Encode.forHtml(unsafeData)%>" title='<%=Encode.forHtml(moreUnsafeData)%>' /> | |||
| * </pre> | |||
There was a problem hiding this comment.
Inspired by the JSP example in forHtml() JavaDocs, but demonstrates usage with both single-quotes and double-quotes.
meeque
commented
Apr 18, 2024
| @@ -276,6 +276,8 @@ public static void forHtmlContent(Writer out, String input) | |||
| * | |||
| * <p><b>Additional Notes</b></p> | |||
| * <ul> | |||
| * <li>When using this method, the caller must provide quotes around the attribute value.</li> | |||
There was a problem hiding this comment.
Don't like this phrasing, but I chose it because forHtmlUnquotedAttribute() JavaDocs use similar phrasing.
|
Disclaimer: I've put these minor doc changes together through the Github web UI. Haven't actually generated JavaDocs from it yet. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See issue #71.