From 859f837d46a2e7f00a2f43d654a01c5de1b61b1f Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Thu, 7 Mar 2019 09:08:55 +0100 Subject: [PATCH] Fix some qdoc warnings src/corelib/itemmodels/qtransposeproxymodel.cpp:166: (qdoc) warning: Unknown command '\details' src/corelib/itemmodels/qconcatenatetablesproxymodel.cpp:102: (qdoc) warning: '\brief' statement does not end with a full stop. src/corelib/itemmodels/qconcatenatetablesproxymodel.cpp:233: (qdoc) warning: Undocumented parameter 'index' in QConcatenateTablesProxyModel::flags() src/corelib/itemmodels/qconcatenatetablesproxymodel.cpp:165: (qdoc) warning: Undocumented parameter 'proxyIndex' in QConcatenateTablesProxyModel::mapToSource() src/corelib/io/qresource.cpp:275: (qdoc) warning: Can't link to 'isCopressed()' src/corelib/io/qresource.cpp:555: (qdoc) warning: Can't link to 'compressionType()' src/network/ssl/qocspresponse.cpp:47: (qdoc) warning: '\brief' statement does not end with a full stop. src/network/ssl/qocspresponse.cpp:47: (qdoc) warning: Can't link to 'QSslSocket::ocspResponse()' src/gui/image/qimage.cpp:2247: (qdoc) warning: Undocumented parameter 'f' in QImage::convertTo() src/gui/image/qimage.cpp:2247: (qdoc) warning: No such parameter 'format' in QImage::convertTo() src/gui/text/qtextformat.cpp:1420: (qdoc) warning: Undocumented parameter 'styleName' in QTextCharFormat::setFontStyleName() src/gui/text/qtextformat.cpp:1420: (qdoc) warning: No such parameter 'style' in QTextCharFormat::setFontStyleName() src/widgets/dialogs/qdialog.cpp:151: (qdoc) warning: Unknown command '\p' src/widgets/dialogs/qdialog.cpp:167: (qdoc) warning: Unknown command '\p' src/widgets/dialogs/qdialog.cpp:167: (qdoc) warning: Unknown command '\p' src/widgets/dialogs/qdialog.cpp:168: (qdoc) warning: Unknown command '\p' Change-Id: Ide52b70f8e72d53767d489ce1a413cf4c2dce7df Reviewed-by: Leena Miettinen --- src/corelib/io/qresource.cpp | 4 ++-- src/corelib/itemmodels/qconcatenatetablesproxymodel.cpp | 8 ++++---- src/corelib/itemmodels/qtransposeproxymodel.cpp | 5 +++-- src/gui/image/qimage.cpp | 8 ++++---- src/gui/text/qtextformat.cpp | 2 +- src/network/ssl/qocspresponse.cpp | 4 ++-- src/widgets/dialogs/qdialog.cpp | 6 +++--- 7 files changed, 19 insertions(+), 18 deletions(-) diff --git a/src/corelib/io/qresource.cpp b/src/corelib/io/qresource.cpp index 1077e31797f..e7d739b4dc5 100644 --- a/src/corelib/io/qresource.cpp +++ b/src/corelib/io/qresource.cpp @@ -286,7 +286,7 @@ static inline QStringList *resourceSearchPaths() decompress, use the \c{ZSTD_decompress} function from the zstd library. - \sa compressionAlgorithm(), isCopressed() + \sa compressionAlgorithm(), isCompressed() */ class QResourcePrivate { @@ -558,7 +558,7 @@ bool QResource::isValid() const check compressionAlgorithm() to verify what algorithm to use to decompress the data. - \sa data(), compressionType(), isFile() + \sa data(), compressionAlgorithm(), isFile() */ bool QResource::isCompressed() const diff --git a/src/corelib/itemmodels/qconcatenatetablesproxymodel.cpp b/src/corelib/itemmodels/qconcatenatetablesproxymodel.cpp index bbfe2dce16a..a20024f4684 100644 --- a/src/corelib/itemmodels/qconcatenatetablesproxymodel.cpp +++ b/src/corelib/itemmodels/qconcatenatetablesproxymodel.cpp @@ -103,7 +103,7 @@ QConcatenateTablesProxyModelPrivate::QConcatenateTablesProxyModelPrivate() \since 5.13 \class QConcatenateTablesProxyModel \inmodule QtCore - \brief The QConcatenateTablesProxyModel class proxies multiple source models, concatenating their rows + \brief The QConcatenateTablesProxyModel class proxies multiple source models, concatenating their rows. \ingroup model-view @@ -163,7 +163,7 @@ QModelIndex QConcatenateTablesProxyModel::mapFromSource(const QModelIndex &sourc } /*! - Returns the source index for a given proxy index. + Returns the source index for a given \a proxyIndex. */ QModelIndex QConcatenateTablesProxyModel::mapToSource(const QModelIndex &proxyIndex) const { @@ -232,8 +232,8 @@ bool QConcatenateTablesProxyModel::setItemData(const QModelIndex &proxyIndex, co /*! Returns the flags for the given index. - If the index is valid, the flags come from the source model for this index. - If the index is invalid (as used to determine if dropping onto an empty area + If the \a index is valid, the flags come from the source model for this \a index. + If the \a index is invalid (as used to determine if dropping onto an empty area in the view is allowed, for instance), the flags from the first model are returned. */ Qt::ItemFlags QConcatenateTablesProxyModel::flags(const QModelIndex &index) const diff --git a/src/corelib/itemmodels/qtransposeproxymodel.cpp b/src/corelib/itemmodels/qtransposeproxymodel.cpp index f15435739cc..d4f379bc64d 100644 --- a/src/corelib/itemmodels/qtransposeproxymodel.cpp +++ b/src/corelib/itemmodels/qtransposeproxymodel.cpp @@ -162,8 +162,9 @@ void QTransposeProxyModelPrivate::onRowsAboutToBeMoved(const QModelIndex &source /*! \since 5.13 \class QTransposeProxyModel - \brief This proxy transposes the source model - \details This model will make the rows of the source model become columns of the proxy model and vice-versa. + \brief This proxy transposes the source model. + + This model will make the rows of the source model become columns of the proxy model and vice-versa. If the model is a tree, the parents will be transposed as well. For example, if an index in the source model had parent `index(2,0)`, it will have parent `index(0,2)` in the proxy. */ diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp index 97123bfec22..18e94cf2562 100644 --- a/src/gui/image/qimage.cpp +++ b/src/gui/image/qimage.cpp @@ -2255,16 +2255,16 @@ bool QImage::reinterpretAsFormat(Format format) \sa convertToFormat() */ -void QImage::convertTo(Format f, Qt::ImageConversionFlags flags) +void QImage::convertTo(Format format, Qt::ImageConversionFlags flags) { - if (!d || f == QImage::Format_Invalid) + if (!d || format == QImage::Format_Invalid) return; detach(); - if (convertToFormat_inplace(f, flags)) + if (convertToFormat_inplace(format, flags)) return; - *this = convertToFormat_helper(f, flags); + *this = convertToFormat_helper(format, flags); } /*! diff --git a/src/gui/text/qtextformat.cpp b/src/gui/text/qtextformat.cpp index 3bae6d4eb74..4a2985f74cf 100644 --- a/src/gui/text/qtextformat.cpp +++ b/src/gui/text/qtextformat.cpp @@ -1421,7 +1421,7 @@ QTextCharFormat::QTextCharFormat(const QTextFormat &fmt) \fn void QTextCharFormat::setFontStyleName(const QString &styleName) \since 5.13 - Sets the text format's font \a style name. + Sets the text format's font \a styleName. \sa setFont(), QFont::setStyleName() */ diff --git a/src/network/ssl/qocspresponse.cpp b/src/network/ssl/qocspresponse.cpp index c3aa6804633..1f2de44859f 100644 --- a/src/network/ssl/qocspresponse.cpp +++ b/src/network/ssl/qocspresponse.cpp @@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE /*! \class QOcspResponse - \brief This class represents Online Certificate Status Protocol response + \brief This class represents Online Certificate Status Protocol response. \since 5.13 \ingroup network @@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE received by the client-side socket during the TLS handshake. QSslSocket must be configured with OCSP stapling enabled. - \sa QSslSocket, QSslSocket::ocspResponse(), certificateStatus(), + \sa QSslSocket, QSslSocket::ocspResponses(), certificateStatus(), revocationReason(), responder(), subject(), QOcspCertificateStatus, QOcspRevocationReason, QSslConfiguration::setOcspStaplingEnabled(), QSslConfiguration::ocspStaplingEnabled(), QSslConfiguration::peerCertificate() diff --git a/src/widgets/dialogs/qdialog.cpp b/src/widgets/dialogs/qdialog.cpp index e7b526445e5..609430fba61 100644 --- a/src/widgets/dialogs/qdialog.cpp +++ b/src/widgets/dialogs/qdialog.cpp @@ -148,7 +148,7 @@ bool QDialogPrivate::canBeNativeDialog() const /*! \internal - Properly hides dialog and sets the \p resultCode + Properly hides dialog and sets the \a resultCode. */ void QDialogPrivate::hide(int resultCode) { @@ -164,8 +164,8 @@ void QDialogPrivate::hide(int resultCode) /*! \internal - Emits finished() signal with \p resultCode. If the \p dialogCode - is equal to 0 emits rejected(), if the \p dialogCode is equal to + Emits finished() signal with \a resultCode. If the \a dialogCode + is equal to 0 emits rejected(), if the \a dialogCode is equal to 1 emits accepted(). */ void QDialogPrivate::finalize(int resultCode, int dialogCode)