[LANG-122] [lang] EscapeUtil.escapeHtml() should clarify that it does not escape ' chars to '

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.1
• Fix Version/s: 2.2

Environment

Operating System: All
Platform: All

• Bugzilla Id: 37385
• Assignee: Unassigned
• Reporter: Dov Wasserman
• Created: 08/Nov/05 01:29
• Updated: 19/Dec/09 15:28
• Resolved: 19/Dec/09 15:28

Description

The official HTML character entity spec does not include the popular "'"
entity name for the single quote character '. the StringUtils class correctly
follows this behavior, leaving single quotes alone. However, many developers
incorrectly assume that ' will get escaped into ' (I was one!) and we can
help them by clarifying this in the Javadoc.

The following could be appended to the method Javadoc:

Note: Not all common HTML entity names are formally included in the standard
specification (http://www.w3.org/TR/REC-html40/sgml/entities.html, as listed
below). This method follows the standard, and thus does not escape the
single-quote ' character into &apos.