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 <riitta-leena.miettinen@qt.io>
This commit is contained in:
Friedemann Kleint 2019-03-07 09:08:55 +01:00
parent fd5e42957d
commit 859f837d46
7 changed files with 19 additions and 18 deletions

View File

@ -286,7 +286,7 @@ static inline QStringList *resourceSearchPaths()
decompress, use the \c{ZSTD_decompress} function from the zstd decompress, use the \c{ZSTD_decompress} function from the zstd
library. library.
\sa compressionAlgorithm(), isCopressed() \sa compressionAlgorithm(), isCompressed()
*/ */
class QResourcePrivate { class QResourcePrivate {
@ -558,7 +558,7 @@ bool QResource::isValid() const
check compressionAlgorithm() to verify what algorithm to use to decompress check compressionAlgorithm() to verify what algorithm to use to decompress
the data. the data.
\sa data(), compressionType(), isFile() \sa data(), compressionAlgorithm(), isFile()
*/ */
bool QResource::isCompressed() const bool QResource::isCompressed() const

View File

@ -103,7 +103,7 @@ QConcatenateTablesProxyModelPrivate::QConcatenateTablesProxyModelPrivate()
\since 5.13 \since 5.13
\class QConcatenateTablesProxyModel \class QConcatenateTablesProxyModel
\inmodule QtCore \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 \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 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. Returns the flags for the given index.
If the index is valid, the flags come from the source model for this index. If the \a index is valid, the flags come from the source model for this \a index.
If the index is invalid (as used to determine if dropping onto an empty area 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. in the view is allowed, for instance), the flags from the first model are returned.
*/ */
Qt::ItemFlags QConcatenateTablesProxyModel::flags(const QModelIndex &index) const Qt::ItemFlags QConcatenateTablesProxyModel::flags(const QModelIndex &index) const

View File

@ -162,8 +162,9 @@ void QTransposeProxyModelPrivate::onRowsAboutToBeMoved(const QModelIndex &source
/*! /*!
\since 5.13 \since 5.13
\class QTransposeProxyModel \class QTransposeProxyModel
\brief This proxy transposes the source model \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.
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. 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.
*/ */

View File

@ -2255,16 +2255,16 @@ bool QImage::reinterpretAsFormat(Format format)
\sa convertToFormat() \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; return;
detach(); detach();
if (convertToFormat_inplace(f, flags)) if (convertToFormat_inplace(format, flags))
return; return;
*this = convertToFormat_helper(f, flags); *this = convertToFormat_helper(format, flags);
} }
/*! /*!

View File

@ -1421,7 +1421,7 @@ QTextCharFormat::QTextCharFormat(const QTextFormat &fmt)
\fn void QTextCharFormat::setFontStyleName(const QString &styleName) \fn void QTextCharFormat::setFontStyleName(const QString &styleName)
\since 5.13 \since 5.13
Sets the text format's font \a style name. Sets the text format's font \a styleName.
\sa setFont(), QFont::setStyleName() \sa setFont(), QFont::setStyleName()
*/ */

View File

@ -46,7 +46,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\class QOcspResponse \class QOcspResponse
\brief This class represents Online Certificate Status Protocol response \brief This class represents Online Certificate Status Protocol response.
\since 5.13 \since 5.13
\ingroup network \ingroup network
@ -57,7 +57,7 @@ QT_BEGIN_NAMESPACE
received by the client-side socket during the TLS handshake. QSslSocket must be received by the client-side socket during the TLS handshake. QSslSocket must be
configured with OCSP stapling enabled. configured with OCSP stapling enabled.
\sa QSslSocket, QSslSocket::ocspResponse(), certificateStatus(), \sa QSslSocket, QSslSocket::ocspResponses(), certificateStatus(),
revocationReason(), responder(), subject(), QOcspCertificateStatus, QOcspRevocationReason, revocationReason(), responder(), subject(), QOcspCertificateStatus, QOcspRevocationReason,
QSslConfiguration::setOcspStaplingEnabled(), QSslConfiguration::ocspStaplingEnabled(), QSslConfiguration::setOcspStaplingEnabled(), QSslConfiguration::ocspStaplingEnabled(),
QSslConfiguration::peerCertificate() QSslConfiguration::peerCertificate()

View File

@ -148,7 +148,7 @@ bool QDialogPrivate::canBeNativeDialog() const
/*! /*!
\internal \internal
Properly hides dialog and sets the \p resultCode Properly hides dialog and sets the \a resultCode.
*/ */
void QDialogPrivate::hide(int resultCode) void QDialogPrivate::hide(int resultCode)
{ {
@ -164,8 +164,8 @@ void QDialogPrivate::hide(int resultCode)
/*! /*!
\internal \internal
Emits finished() signal with \p resultCode. If the \p dialogCode Emits finished() signal with \a resultCode. If the \a dialogCode
is equal to 0 emits rejected(), if the \p dialogCode is equal to is equal to 0 emits rejected(), if the \a dialogCode is equal to
1 emits accepted(). 1 emits accepted().
*/ */
void QDialogPrivate::finalize(int resultCode, int dialogCode) void QDialogPrivate::finalize(int resultCode, int dialogCode)