Author: msahyoun
Date: Wed Aug 26 07:42:36 2026
New Revision: 1937473
Log:
PDFBOX-6242: enhance javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFUtils.java
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFUtils.java
==============================================================================
---
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFUtils.java
Wed Aug 26 07:42:12 2026 (r1937472)
+++
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/fdf/FDFUtils.java
Wed Aug 26 07:42:36 2026 (r1937473)
@@ -23,13 +23,18 @@ public class FDFUtils {
private static final Logger LOG = LogManager.getLogger(FDFDocument.class);
-
/**
- * Escape special characters.
+ * Escapes special characters for use in XML 1.0.
+ * <p>
+ * Characters that are not permitted in XML 1.0 are replaced with the
+ * Unicode replacement character (U+FFFD). If one or more characters are
+ * replaced, the number of replacements is logged at INFO level.
+ * </p>
*
* @param input the string to be escaped.
*
- * @return the resulting string
+ * @return the resulting string with XML special characters escaped and
+ * characters invalid in XML 1.0 replaced with U+FFFD.
*/
static String escapeXML10(String input)
{
