diff options
| author | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2020-09-21 23:57:43 +0200 |
|---|---|---|
| committer | Volker Hilsheimer <volker.hilsheimer@qt.io> | 2020-09-22 20:55:49 +0200 |
| commit | 5b0a5ac20c219ebb0baba1df2951dd33c25a18b6 (patch) | |
| tree | 8a1033142f6f01df3faa6e3dd44e291196ff555a /src/gui/text | |
| parent | 89627fd7f977c74494c5c7578ce1f58f2ffbe26a (diff) | |
| download | qtbase-5b0a5ac20c219ebb0baba1df2951dd33c25a18b6.tar.gz | |
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')
| -rw-r--r-- | src/gui/text/qtextdocument.cpp | 11 | ||||
| -rw-r--r-- | src/gui/text/qtextformat.cpp | 10 |
2 files changed, 12 insertions, 9 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() diff --git a/src/gui/text/qtextformat.cpp b/src/gui/text/qtextformat.cpp index 62cc8e84b7..af1fdfa653 100644 --- a/src/gui/text/qtextformat.cpp +++ b/src/gui/text/qtextformat.cpp @@ -1803,7 +1803,8 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) \fn void QTextCharFormat::setSuperScriptBaseline(qreal baseline) \since 6.0 - Sets the superscript's base line as a % of font height. The default value is 50% (1/2 of height) + Sets the superscript's base line as a % of font height to \a baseline. + The default value is 50% (1/2 of height). \sa superScriptBaseline(), setSubScriptBaseline(), subScriptBaseline(), setBaselineOffset(), baselineOffset() */ @@ -1821,7 +1822,8 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) \fn void QTextCharFormat::setSubScriptBaseline(qreal baseline) \since 6.0 - Sets the subscript's base line as a % of font height. The default value is 16.67% (1/6 of height) + Sets the subscript's base line as a % of font height to \a baseline. + The default value is 16.67% (1/6 of height) \sa subScriptBaseline(), setSuperScriptBaseline(), superScriptBaseline(), setBaselineOffset(), baselineOffset() */ @@ -1839,8 +1841,8 @@ void QTextCharFormat::setUnderlineStyle(UnderlineStyle style) \fn void QTextCharFormat::setBaselineOffset(qreal baseline) \since 6.0 - Sets the baseline (in % of height) of text. A positive value moves up the text, by the corresponding %; - a negative value moves it down. The default value is 0. + Sets the base line (in % of height) of text to \a baseline. A positive value moves the text + up, by the corresponding %; a negative value moves it down. The default value is 0. \sa baselineOffset(), setSubScriptBaseline(), subScriptBaseline(), setSuperScriptBaseline(), superScriptBaseline() */ |