summaryrefslogtreecommitdiffstats
path: root/src/gui/text/qtextdocument.cpp
diff options
context:
space:
mode:
authorVolker Hilsheimer <volker.hilsheimer@qt.io>2020-09-21 23:57:43 +0200
committerVolker Hilsheimer <volker.hilsheimer@qt.io>2020-09-22 20:55:49 +0200
commit5b0a5ac20c219ebb0baba1df2951dd33c25a18b6 (patch)
tree8a1033142f6f01df3faa6e3dd44e291196ff555a /src/gui/text/qtextdocument.cpp
parent89627fd7f977c74494c5c7578ce1f58f2ffbe26a (diff)
Fix some qdoc warnings: function parameter names
In QTextDocument and QTextFormat, standardize language a bit. Change-Id: I7c81ecc7a32e36ec32214e6b5386a2827cfcbc3f Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/gui/text/qtextdocument.cpp')
-rw-r--r--src/gui/text/qtextdocument.cpp11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp
index 2af1c57286..ff142794f6 100644
--- a/src/gui/text/qtextdocument.cpp
+++ b/src/gui/text/qtextdocument.cpp
@@ -1736,8 +1736,8 @@ QFont QTextDocument::defaultFont() const
\fn void QTextDocument::setSuperScriptBaseline(qreal baseline)
\since 6.0
- Sets the default superscript's base line as a % of font height to use in the document layout.
- The default value is 50% (1/2 of height)
+ Sets the default superscript's base line as a % of font height to use in the document
+ layout to \a baseline. The default value is 50% (1/2 of height).
\sa superScriptBaseline(), setSubScriptBaseline(), subScriptBaseline(), setBaselineOffset(), baselineOffset()
*/
@@ -1765,8 +1765,8 @@ qreal QTextDocument::superScriptBaseline() const
\fn void QTextDocument::setSubScriptBaseline(qreal baseline)
\since 6.0
- Sets the default subscript's base line as a % of font height to use in the document layout.
- The default value is 16.67% (1/6 of height)
+ Sets the default subscript's base line as a % of font height to use in the document layout
+ to \a baseline. The default value is 16.67% (1/6 of height).
\sa subScriptBaseline(), setSuperScriptBaseline(), superScriptBaseline(), setBaselineOffset(), baselineOffset()
*/
@@ -1794,7 +1794,8 @@ qreal QTextDocument::subScriptBaseline() const
\fn void QTextDocument::setBaselineOffset(qreal baseline)
\since 6.0
- Sets the baseline (in % of height) to use in the document layout. The default value is 0.
+ Sets the base line as a% of font height to use in the document layout to \a baseline.
+ The default value is 0.
A positive value moves up the text, by the corresponding %; a negative value moves it down.
\sa baselineOffset(), setSubScriptBaseline(), subScriptBaseline(), setSuperScriptBaseline(), superScriptBaseline()