NXP-16678: javadoc and @SInCE

nuxeo · Oct 2, 2015 · 9df2610 · 9df2610
1 parent 819fa28
commit 9df2610
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/...utomation-features/src/main/java/org/nuxeo/ecm/automation/features/PlatformFunctions.java b/...utomation-features/src/main/java/org/nuxeo/ecm/automation/features/PlatformFunctions.java
@@ -162,6 +162,15 @@ public static String htmlEscape(String str) {
         return StringEscapeUtils.escapeHtml(str);
     }
 
+    /**
+     * Escapes a string according to NXQL escaping rules.
+     * <p>
+     * The resulting string is safe to include between single quotes in a NXQL expression.
+     *
+     * @param str the input string
+     * @return the escaped string
+     * @since 6.0-HF21, 7.10
+     */
     public static String nxqlEscape(String str) {
         return NXQL.escapeStringInner(str);
     }