aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/util/qquickfontmetrics.cpp
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-07-18 15:18:31 +0200
committerTopi Reinio <topi.reinio@qt.io>2019-08-29 13:04:58 +0200
commit1dc3f4c24583e14dee3c5fa650a8ac239b953458 (patch)
treebae8b90629c3215ec254221388aad85813237b32 /src/quick/util/qquickfontmetrics.cpp
parentda04b1d716617fbe4a2d93dc5a51f38dbd03a5b8 (diff)
Doc: Fix documentation warnings for qtdeclarative
After recent changes to QDoc, it now correctly warns about missing documentation for QML method parameters - fix all of these and also do some minor language editing. Remove duplicated entries for - \qmlmodule Qt.labs.qmlmodels - \group qtjavascript as they were causing issues. Change-Id: I55cd670cc8a0cc6427cdb7945dbd7c28ea94f796 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src/quick/util/qquickfontmetrics.cpp')
-rw-r--r--src/quick/util/qquickfontmetrics.cpp7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/quick/util/qquickfontmetrics.cpp b/src/quick/util/qquickfontmetrics.cpp
index 42b3038c48..c9a9008180 100644
--- a/src/quick/util/qquickfontmetrics.cpp
+++ b/src/quick/util/qquickfontmetrics.cpp
@@ -327,10 +327,13 @@ QRectF QQuickFontMetrics::tightBoundingRect(const QString &text) const
/*!
\qmlmethod string QtQuick::FontMetrics::elidedText(string text, enumeration mode, real width, int flags)
- This method returns a returns an elided version of the string (i.e., a
+ This method returns an elided version of the string (i.e., a
string with "..." in it) if the string \a text is wider than \a width.
Otherwise, returns the original string.
+ The \a mode argument specifies the text elide mode; that is, where
+ the ellipsis should appear when displaying text that doesn't fit.
+
The \a flags argument is optional and currently only supports
\l {Qt::TextShowMnemonic}.
@@ -338,7 +341,7 @@ QRectF QQuickFontMetrics::tightBoundingRect(const QString &text) const
\l {QQuickTextMetrics::elidedText}{elidedText} property of
\l {QQuickTextMetrics::elidedText}{TextMetrics}.
- \sa {QFontMetricsF::elidedText()}
+ \sa Qt::TextElideMode, QFontMetricsF::elidedText()
*/
QString QQuickFontMetrics::elidedText(const QString &text, Qt::TextElideMode mode, qreal width, int flags) const
{