summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDan Cape <dcape@qnx.com>2016-03-24 16:27:24 -0400
committerDan Cape <dcape@qnx.com>2016-04-08 16:06:29 +0000
commite187a16906e68effcccdd7931c755e610b62e358 (patch)
tree4b63a0ddb1a567ca0cfe8706cd7c8f5758da76ab /src
parentb414b9e6cddaa14e38bc21fe6c67899315632a49 (diff)
toCurrencyString() - Add missing documentation
Documentation was missing for the new toCurrencyString() function that adds a precision value. Change-Id: I16c10cdd18dfc37839fccb907470b0942f100e5d Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src')
-rw-r--r--src/corelib/tools/qlocale.cpp8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/corelib/tools/qlocale.cpp b/src/corelib/tools/qlocale.cpp
index 20716ceb26..27d2e4c165 100644
--- a/src/corelib/tools/qlocale.cpp
+++ b/src/corelib/tools/qlocale.cpp
@@ -3487,7 +3487,13 @@ QString QLocale::toCurrencyString(double value, const QString &symbol) const
/*!
\since 5.7
- \overload
+ \overload toCurrencyString()
+
+ Returns a localized string representation of \a value as a currency.
+ If the \a symbol is provided it is used instead of the default currency symbol.
+ If the \a precision is provided it is used to set the precision of the currency value.
+
+ \sa currencySymbol()
*/
QString QLocale::toCurrencyString(double value, const QString &symbol, int precision) const
{