Better dox, spelling

This commit is contained in:
Nyall Dawson 2018-06-01 08:16:31 +10:00
parent f7a6864b9c
commit 32792d3409
2 changed files with 10 additions and 4 deletions

View File

@ -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 é 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

View File

@ -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 );