Better dox, spelling

qgis · May 31, 2018 · 32792d3 · 32792d3
1 parent f7a6864
commit 32792d3
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/python/core/auto_generated/qgsstringutils.sip.in b/python/core/auto_generated/qgsstringutils.sip.in
@@ -191,8 +191,11 @@ Converts a string by applying capitalization rules to the string.
 
     static QString ampersandEncode( const QString &string );
 %Docstring
-Replaces any extended unicode characters with the XML style &#233; encoded versions
-of these characeters.
+Makes a raw string safe for inclusion as a HTML/XML string literal.
+
+This includes replacing '<' with '&lt;', '>' with '&gt;', '&' with '&amp', and
+any extended unicode characters with the XML style &#233; encoded versions
+of these characters.
 
 .. versionadded:: 3.2
 %End

diff --git a/src/core/qgsstringutils.h b/src/core/qgsstringutils.h
@@ -201,8 +201,11 @@ class CORE_EXPORT QgsStringUtils
     static QString capitalize( const QString &string, Capitalization capitalization );
 
     /**
-     * Replaces any extended unicode characters with the XML style &#233; encoded versions
-     * of these characeters.
+     * Makes a raw string safe for inclusion as a HTML/XML string literal.
+     *
+     * This includes replacing '<' with '&lt;', '>' with '&gt;', '&' with '&amp', and
+     * any extended unicode characters with the XML style &#233; encoded versions
+     * of these characters.
      * \since QGIS 3.2
      */
     static QString ampersandEncode( const QString &string );