From 4554fa7b191566df0a6c07e686c642c78eb88095 Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Fri, 15 Mar 2019 13:27:44 +0100 Subject: Fix some qdoc warnings src/network/ssl/qsslsocket.cpp:1501: (qdoc) warning: Can't link to 'QSslConfiguration::defaultCaCertificates()' src/network/ssl/qsslsocket.cpp:1482: (qdoc) warning: Can't link to 'QSslConfiguration::defaultCaCertificates()' src/network/ssl/qsslsocket.cpp:1513: (qdoc) warning: Can't link to 'QSslConfiguration::defaultCaCertificates()' src/network/ssl/qsslsocket.cpp:1119: (qdoc) warning: Can't link to 'QSslConfiguration::setDefaultCiphers()' src/network/ssl/qsslsocket.cpp:1119: (qdoc) warning: Can't link to 'QSslConfiguration::defaultCiphers()' src/gui/opengl/qopengltexture.cpp:4137: (qdoc) warning: Can't link to 'setComparisonFunction()' src/widgets/dialogs/qfilesystemmodel.cpp:1215: (qdoc) warning: Undocumented return value (hint: use 'return' or 'returns' in the text src/widgets/graphicsview/qgraphicswidget.cpp:1229: (qdoc) warning: Undocumented return value (hint: use 'return' or 'returns' in the text src/widgets/graphicsview/qgraphicsscene.cpp:3313: (qdoc) warning: Undocumented return value (hint: use 'return' or 'returns' in the text src/gui/painting/qpaintengine_raster.cpp:3438: (qdoc) warning: Undocumented return value (hint: use 'return' or 'returns' in the text src/widgets/widgets/qtextedit.cpp:2544: (qdoc) warning: Overrides a previous doc src/widgets/widgets/qplaintextedit.cpp:2932: (qdoc) warning: (The previous doc is here) Change-Id: I0c68c59a87eb6a5d9e974f857af6aca0c6e0672d Reviewed-by: Paul Wicking --- src/gui/opengl/qopengltexture.cpp | 2 +- src/gui/painting/qpaintengine_raster.cpp | 2 +- src/network/ssl/qsslsocket.cpp | 8 ++++---- src/widgets/graphicsview/qgraphicsscene.cpp | 3 +++ src/widgets/graphicsview/qgraphicswidget.cpp | 3 +++ src/widgets/itemviews/qabstractitemview.cpp | 3 +++ src/widgets/widgets/qplaintextedit.cpp | 2 +- 7 files changed, 16 insertions(+), 7 deletions(-) diff --git a/src/gui/opengl/qopengltexture.cpp b/src/gui/opengl/qopengltexture.cpp index 5b7956d31e..e04a00e592 100644 --- a/src/gui/opengl/qopengltexture.cpp +++ b/src/gui/opengl/qopengltexture.cpp @@ -4114,7 +4114,7 @@ QOpenGLTexture::DepthStencilMode QOpenGLTexture::depthStencilMode() const */ -/* +/*! \since 5.5 Sets the texture comparison function on this texture to \a function. The texture diff --git a/src/gui/painting/qpaintengine_raster.cpp b/src/gui/painting/qpaintengine_raster.cpp index 0f5c7756ad..d3404c6575 100644 --- a/src/gui/painting/qpaintengine_raster.cpp +++ b/src/gui/painting/qpaintengine_raster.cpp @@ -3436,7 +3436,7 @@ bool QRasterPaintEngine::requiresPretransformedGlyphPositions(QFontEngine *fontE } /*! - Indicates whether glyph caching is supported by the font engine + Returns whether glyph caching is supported by the font engine \a fontEngine with the given transform \a m applied. */ bool QRasterPaintEngine::shouldDrawCachedGlyphs(QFontEngine *fontEngine, const QTransform &m) const diff --git a/src/network/ssl/qsslsocket.cpp b/src/network/ssl/qsslsocket.cpp index cf8a472606..e164217e4e 100644 --- a/src/network/ssl/qsslsocket.cpp +++ b/src/network/ssl/qsslsocket.cpp @@ -1128,8 +1128,8 @@ QList QSslSocket::peerCertificateChain() const handshake phase begins. \sa QSslConfiguration::ciphers(), QSslConfiguration::setCiphers(), - QSslConfiguration::setDefaultCiphers(), - QSslConfiguration::defaultCiphers(), + QSslConfiguration::setCiphers(), + QSslConfiguration::ciphers(), QSslConfiguration::supportedCiphers() */ QSslCipher QSslSocket::sessionCipher() const @@ -1489,7 +1489,7 @@ QList QSslSocket::caCertificates() const Each SSL socket's CA certificate database is initialized to the default CA certificate database. - \sa QSslConfiguration::defaultCaCertificates(), addCaCertificates(), + \sa QSslConfiguration::caCertificates(), addCaCertificates(), addDefaultCaCertificate() */ bool QSslSocket::addDefaultCaCertificates(const QString &path, QSsl::EncodingFormat encoding, @@ -1515,7 +1515,7 @@ void QSslSocket::addDefaultCaCertificate(const QSslCertificate &certificate) SSL socket's CA certificate database is initialized to the default CA certificate database. - \sa QSslConfiguration::defaultCaCertificates(), addCaCertificates() + \sa QSslConfiguration::caCertificates(), addCaCertificates() */ void QSslSocket::addDefaultCaCertificates(const QList &certificates) { diff --git a/src/widgets/graphicsview/qgraphicsscene.cpp b/src/widgets/graphicsview/qgraphicsscene.cpp index 8bdce4af8b..19d9f25307 100644 --- a/src/widgets/graphicsview/qgraphicsscene.cpp +++ b/src/widgets/graphicsview/qgraphicsscene.cpp @@ -3324,6 +3324,9 @@ void QGraphicsScene::advance() \l{QWidget::}{enterEvent()} and \l{QWidget::}{leaveEvent()}. Use this function to obtain those events instead. + Returns \c true if \a event has been recognized and processed; otherwise, + returns \c false. + \sa contextMenuEvent(), keyPressEvent(), keyReleaseEvent(), mousePressEvent(), mouseMoveEvent(), mouseReleaseEvent(), mouseDoubleClickEvent(), focusInEvent(), focusOutEvent() diff --git a/src/widgets/graphicsview/qgraphicswidget.cpp b/src/widgets/graphicsview/qgraphicswidget.cpp index f69faa7572..ad3be5766d 100644 --- a/src/widgets/graphicsview/qgraphicswidget.cpp +++ b/src/widgets/graphicsview/qgraphicswidget.cpp @@ -1232,6 +1232,9 @@ QVariant QGraphicsWidget::propertyChange(const QString &propertyName, const QVar event() or in any of the convenience functions; you should not have to reimplement this function in a subclass of QGraphicsWidget. + Returns \c true if \a event has been recognized and processed; otherwise, + returns \c false. + \sa QGraphicsItem::sceneEvent() */ bool QGraphicsWidget::sceneEvent(QEvent *event) diff --git a/src/widgets/itemviews/qabstractitemview.cpp b/src/widgets/itemviews/qabstractitemview.cpp index 59d3ed1d15..95631ffa5f 100644 --- a/src/widgets/itemviews/qabstractitemview.cpp +++ b/src/widgets/itemviews/qabstractitemview.cpp @@ -1689,6 +1689,9 @@ bool QAbstractItemView::event(QEvent *event) This? mode, if the given \a event is a QEvent::ToolTip,or a QEvent::WhatsThis. It passes all other events on to its base class viewportEvent() handler. + + Returns \c true if \a event has been recognized and processed; otherwise, + returns \c false. */ bool QAbstractItemView::viewportEvent(QEvent *event) { diff --git a/src/widgets/widgets/qplaintextedit.cpp b/src/widgets/widgets/qplaintextedit.cpp index 363422ac74..dc8765ad88 100644 --- a/src/widgets/widgets/qplaintextedit.cpp +++ b/src/widgets/widgets/qplaintextedit.cpp @@ -2930,7 +2930,7 @@ bool QPlainTextEdit::find(const QRegExp &exp, QTextDocument::FindFlags options) #endif /*! - \fn bool QTextEdit::find(const QRegularExpression &exp, QTextDocument::FindFlags options) + \fn bool QPlainTextEdit::find(const QRegularExpression &exp, QTextDocument::FindFlags options) \since 5.13 \overload -- cgit v1.2.3