Skip to content

Improve Encode.forHtmlAttribute docs #72

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

Merged
jeremylong merged 4 commits into from
Jul 26, 2024
Merged

Improve Encode.forHtmlAttribute docs #72

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15903b4
Improve a JSP example in JavaDocs.
meeque Apr 18, 2024
0b581f8
Make JSP example in JavaDocs more concise.
meeque Apr 18, 2024
604a78f
Be clearer about quotes in forHtmlAttribute docs.
meeque Apr 18, 2024
351e999
docs: correct javadoc
jeremylong Jul 26, 2024
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
4 changes: 3 additions & 1 deletion core/src/main/java/org/owasp/encoder/Encode.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ public static void forHtmlContent(Writer out, String input)
*
* <b>Example JSP Usage</b>
* <pre>
* &lt;div&gt;&lt;%=Encode.forHtmlAttribute(unsafeData)%&gt;&lt;/div&gt;
* &lt;input value=&quot;&lt;%=Encode.forHtmlAttribute(unsafeData)%&gt;&quot; title=&#39;&lt;%=Encode.forHtmlAttribute(moreUnsafeData)%&gt;&#39; /&gt;
* </pre>
*
* <table border="0" class="memberSummary" summary="Shows the input and results of encoding">
Expand Down Expand Up @@ -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>
Copy link
Contributor Author

@meeque meeque Apr 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't like this phrasing, but I chose it because forHtmlUnquotedAttribute() JavaDocs use similar phrasing.

*
* <li>Both the single-quote character ({@code '}) and the
* double-quote character ({@code "}) are encoded so this is safe
* for HTML attributes with either enclosing character.</li>
Expand Down