From 5b0a5ac20c219ebb0baba1df2951dd33c25a18b6 Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Mon, 21 Sep 2020 23:57:43 +0200 Subject: Fix some qdoc warnings: function parameter names In QTextDocument and QTextFormat, standardize language a bit. Change-Id: I7c81ecc7a32e36ec32214e6b5386a2827cfcbc3f Reviewed-by: Paul Wicking --- src/corelib/io/qiodevice.cpp | 2 +- src/corelib/kernel/qmetatype.cpp | 6 +++--- src/gui/text/qtextdocument.cpp | 11 ++++++----- src/gui/text/qtextformat.cpp | 10 ++++++---- 4 files changed, 16 insertions(+), 13 deletions(-) diff --git a/src/corelib/io/qiodevice.cpp b/src/corelib/io/qiodevice.cpp index d64c2f37cb..924876b785 100644 --- a/src/corelib/io/qiodevice.cpp +++ b/src/corelib/io/qiodevice.cpp @@ -1727,7 +1727,7 @@ qint64 QIODevice::write(const char *data) /*! \overload - Writes the content of \a byteArray to the device. Returns the number of + Writes the content of \a data to the device. Returns the number of bytes that were actually written, or -1 if an error occurred. \sa read(), writeData() diff --git a/src/corelib/kernel/qmetatype.cpp b/src/corelib/kernel/qmetatype.cpp index 798d43686a..a1dcf2d130 100644 --- a/src/corelib/kernel/qmetatype.cpp +++ b/src/corelib/kernel/qmetatype.cpp @@ -2450,8 +2450,8 @@ bool QMetaType::canConvert(QMetaType fromType, QMetaType toType) */ /*! - Returns \c true, if the meta type system has a registered conversion from meta type id \a fromTypeId - to \a toTypeId + Returns \c true, if the meta type system has a registered conversion from meta type id \a fromType + to \a toType \since 5.2 */ bool QMetaType::hasRegisteredConverterFunction(QMetaType fromType, QMetaType toType) @@ -2468,7 +2468,7 @@ bool QMetaType::hasRegisteredConverterFunction(QMetaType fromType, QMetaType toT /*! Returns \c true, if the meta type system has a registered mutable view on meta type id - \a fromTypeId of meta type id \a toTypeId. + \a fromType of meta type id \a toType. \since 5.2 */ bool QMetaType::hasRegisteredMutableViewFunction(QMetaType fromType, QMetaType toType) 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() */ -- cgit v1.2.3