From 3f135dbcb931bc74741f0f23831831775b84eba3 Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Thu, 20 Apr 2017 16:53:47 +0200 Subject: [PATCH] Docs: Fix some warnings qtbase/src/corelib/tools/qbytearray.cpp:3043: warning: Can't link to '.' qtbase/src/corelib/tools/qstring.cpp:4522: warning: Can't link to '.' qtbase/src/corelib/tools/qstring.cpp:10331: warning: Can't link to '.' qtbase/src/network/access/qhstspolicy.cpp:105: warning: Undocumented parameter 'flags' in QHstsPolicy::QHstsPolicy() qtbase/src/network/access/qhstspolicy.cpp:105: warning: No such parameter 'includeSubDomains' in QHstsPolicy::QHstsPolicy() qtbase/src/network/access/qnetworkaccessmanager.cpp:732: warning: Undocumented parameter 'knownHosts' in QNetworkAccessManager::addStrictTransportSecurityHosts() qtbase/src/network/access/qnetworkreply.cpp:307: warning: Can't link to 'QNetworkRequest::UserVerifiedRedirectsPolicy' qtbase/src/gui/painting/qpagedpaintdevice.cpp:246: warning: No such enum item 'PdfFormat_1_4' in QPagedPaintDevice::PdfVersion qtbase/src/gui/painting/qpagedpaintdevice.cpp:246: warning: Undocumented enum item 'PdfVersion_1_4' in QPagedPaintDevice::PdfVersion qtbase/src/gui/painting/qpagedpaintdevice.cpp:246: warning: Undocumented enum item 'PdfVersion_A1b' in QPagedPaintDevice::PdfVersion qtbase/src/gui/painting/qpagedpaintdevice.cpp:246: warning: No such enum item 'PdfFormat_A1b' in QPagedPaintDevice::PdfVersion qtbase/src/widgets/kernel/qopenglwidget.cpp:1076: warning: Undocumented parameter 'texFormat' in QOpenGLWidget::setTextureFormat() qtbase/src/corelib/tools/qversionnumber.cpp:460: warning: Command '\snippet (//! [3-latin1-1])' failed at end of file 'qversionnumber/main.cpp' Change-Id: Icc163dd8d94cee7e0858040bf8241a3c1f1d221d Reviewed-by: Laszlo Agocs --- src/corelib/doc/snippets/qversionnumber/main.cpp | 4 ++-- src/corelib/kernel/qmetatype.cpp | 1 + src/corelib/tools/qbytearray.cpp | 2 +- src/corelib/tools/qstring.cpp | 4 ++-- src/gui/painting/qpagedpaintdevice.cpp | 4 ++-- src/network/access/qnetworkaccessmanager.cpp | 2 +- src/network/access/qnetworkreply.cpp | 4 ++-- src/widgets/kernel/qopenglwidget.cpp | 2 +- 8 files changed, 12 insertions(+), 11 deletions(-) diff --git a/src/corelib/doc/snippets/qversionnumber/main.cpp b/src/corelib/doc/snippets/qversionnumber/main.cpp index 50a893603f..27b7b1a7ef 100644 --- a/src/corelib/doc/snippets/qversionnumber/main.cpp +++ b/src/corelib/doc/snippets/qversionnumber/main.cpp @@ -96,13 +96,13 @@ void QObject::parse() // suffixIndex is 5 //! [3] - //! [3-latin-1] + //! [3-latin1-1] QLatin1String string("5.4.0-alpha"); int suffixIndex; auto version = QVersionNumber::fromString(string, &suffixIndex); // version is 5.4.0 // suffixIndex is 5 - //! [3-latin-1] + //! [3-latin1-1] } void Object::equivalent() diff --git a/src/corelib/kernel/qmetatype.cpp b/src/corelib/kernel/qmetatype.cpp index b75f2ad9dc..e48807ea49 100644 --- a/src/corelib/kernel/qmetatype.cpp +++ b/src/corelib/kernel/qmetatype.cpp @@ -308,6 +308,7 @@ struct DefinedTypesFilter { \omitvalue TrackingPointerToQObject \omitvalue WasDeclaredAsMetaType \omitvalue IsGadget This type is a Q_GADGET and it's corresponding QMetaObject can be accessed with QMetaType::metaObject Since 5.5. + \omitvalue PointerToGadget */ /*! diff --git a/src/corelib/tools/qbytearray.cpp b/src/corelib/tools/qbytearray.cpp index 5f42ff0146..b5b48324e7 100644 --- a/src/corelib/tools/qbytearray.cpp +++ b/src/corelib/tools/qbytearray.cpp @@ -3049,7 +3049,7 @@ QByteArray QByteArray::mid(int pos, int len) const \note The behavior is undefined if \a len is negative or greater than size(). - \sa endsWith(), left(), right(), mid(), chop(), truncate(). + \sa endsWith(), left(), right(), mid(), chop(), truncate() */ /*! diff --git a/src/corelib/tools/qstring.cpp b/src/corelib/tools/qstring.cpp index 6bd2db0de3..e5e2376888 100644 --- a/src/corelib/tools/qstring.cpp +++ b/src/corelib/tools/qstring.cpp @@ -4528,7 +4528,7 @@ QString QString::mid(int position, int n) const \note The behavior is undefined if \a len is negative or greater than size(). - \sa endsWith(), left(), right(), mid(), chop(), truncate(). + \sa endsWith(), left(), right(), mid(), chop(), truncate() */ /*! @@ -10337,7 +10337,7 @@ QStringRef QStringRef::mid(int pos, int n) const \note The behavior is undefined if \a len is negative or greater than size(). - \sa endsWith(), left(), right(), mid(), chop(), truncate(). + \sa endsWith(), left(), right(), mid(), chop(), truncate() */ /*! diff --git a/src/gui/painting/qpagedpaintdevice.cpp b/src/gui/painting/qpagedpaintdevice.cpp index 372b9524ee..1c7d6471b6 100644 --- a/src/gui/painting/qpagedpaintdevice.cpp +++ b/src/gui/painting/qpagedpaintdevice.cpp @@ -249,9 +249,9 @@ QPagedPaintDevicePrivate *QPagedPaintDevice::dd() The PdfVersion enum describes the version of the PDF file that is produced by QPrinter or QPdfWriter. - \value PdfFormat_1_4 A PDF 1.4 compatible document is produced. + \value PdfVersion_1_4 A PDF 1.4 compatible document is produced. - \value PdfFormat_A1b A PDF/A-1b compatible document is produced. + \value PdfVersion_A1b A PDF/A-1b compatible document is produced. \since 5.10 */ diff --git a/src/network/access/qnetworkaccessmanager.cpp b/src/network/access/qnetworkaccessmanager.cpp index d57acc2f6b..79f0aa8038 100644 --- a/src/network/access/qnetworkaccessmanager.cpp +++ b/src/network/access/qnetworkaccessmanager.cpp @@ -732,7 +732,7 @@ bool QNetworkAccessManager::isStrictTransportSecurityEnabled() const /*! \since 5.9 - Adds HTTP Strict Transport Security policies into HSTS cache. + Adds HTTP Strict Transport Security policies contained in \a knownHosts into HSTS cache. \note An expired policy will remove a known host from the cache, if previously present. diff --git a/src/network/access/qnetworkreply.cpp b/src/network/access/qnetworkreply.cpp index 79afd21a1a..cce6ed264e 100644 --- a/src/network/access/qnetworkreply.cpp +++ b/src/network/access/qnetworkreply.cpp @@ -311,9 +311,9 @@ QNetworkReplyPrivate::QNetworkReplyPrivate() When client code handling the redirected() signal has verified the new URL, it emits this signal to allow the redirect to go ahead. This protocol applies to network requests whose redirects policy is set to - QNetworkRequest::UserVerifiedRedirectsPolicy. + QNetworkRequest::UserVerifiedRedirectPolicy - \sa QNetworkRequest::UserVerifiedRedirectsPolicy + \sa QNetworkRequest::UserVerifiedRedirectPolicy QNetworkAccessManager::setRedirectsPolicy(), QNetworkRequest::RedirectsPolicyAttribute */ diff --git a/src/widgets/kernel/qopenglwidget.cpp b/src/widgets/kernel/qopenglwidget.cpp index e401444e6e..6fb36e6b49 100644 --- a/src/widgets/kernel/qopenglwidget.cpp +++ b/src/widgets/kernel/qopenglwidget.cpp @@ -1074,7 +1074,7 @@ QSurfaceFormat QOpenGLWidget::format() const } /*! - Sets a custom internal texture format. + Sets a custom internal texture format of \a texFormat. When working with sRGB framebuffers, it will be necessary to specify a format like \c{GL_SRGB8_ALPHA8}. This can be achieved by calling this