From 0dc5d8e6c92546d83dc84619eb653c6e389edaf1 Mon Sep 17 00:00:00 2001 From: Friedemann Kleint Date: Mon, 27 Jun 2016 13:32:30 +0200 Subject: Fix some qdoc-warnings for Qt 5.8. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit qtbase/src/corelib/tools/qstring.cpp:8341: warning: Unknown command '\length' qtbase/src/corelib/tools/qstring.cpp:8354: warning: Unknown command '\length' qtbase/src/corelib/tools/qstring.cpp:8366: warning: Unknown command '\length' qtbase/src/corelib/doc/src/animation.qdoc:38: warning: Can't link to 'QAbstractAnimation::updateCurrentValue()' qtbase/src/corelib/io/qdatastream.cpp:529: warning: Undocumented enum item 'Qt_5_8' in QDataStream::Version qtbase/src/corelib/tools/qdatetime.cpp:4377: warning: No documentation for 'QDateTime::currentSecsSinceEpoch()' qtbase/src/corelib/tools/qcommandlineoption.cpp:435: warning: Undocumented parameter 'flags' in QCommandLineOption::setFlags() qtbase/src/network/ssl/qsslconfiguration.cpp:857: warning: Undocumented parameter 'dhparams' in QSslConfiguration::setDiffieHellmanParameters() qtbase/src/network/ssl/qsslconfiguration.cpp:830: warning: Undocumented parameter 'hint' in QSslConfiguration::setPreSharedKeyIdentityHint() qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:225: warning: No such enum item 'ErrorUnsafeParameters' in QSslDiffieHellmanParameters::Error qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:225: warning: No such enum item 'ErrorInvalidInputData' in QSslDiffieHellmanParameters::Error qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:225: warning: Undocumented enum item 'UnsafeParametersError' in QSslDiffieHellmanParameters::Error qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:225: warning: Undocumented enum item 'NoError' in QSslDiffieHellmanParameters::Error qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:225: warning: Undocumented enum item 'InvalidInputDataError' in QSslDiffieHellmanParameters::Error qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:105: warning: Undocumented parameter 'encoding' in QSslDiffieHellmanParameters::QSslDiffieHellmanParameters() qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:129: warning: Undocumented parameter 'encoding' in QSslDiffieHellmanParameters::QSslDiffieHellmanParameters() qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:208: warning: Can't link to 'clear()' qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:277: warning: Undocumented parameter 'dhparam' in operator<<() qtbase/src/network/ssl/qssldiffiehellmanparameters.cpp:277: warning: No such parameter 'dhparm' in operator<<() qtbase/src/widgets/kernel/qapplication.cpp:999: warning: Cannot find 'QApplication::autoMaximizeThreshold' specified with '\property' in any header file Change-Id: I4ac00f0fc0dbc4d421cf7c0273635d9681962645 Reviewed-by: Topi Reiniö --- src/corelib/doc/src/animation.qdoc | 2 +- src/corelib/io/qdatastream.cpp | 1 + src/corelib/tools/qcommandlineoption.cpp | 2 +- src/corelib/tools/qdatetime.cpp | 10 ++++++++++ src/corelib/tools/qstring.cpp | 6 +++--- src/network/ssl/qsslconfiguration.cpp | 8 ++++---- src/network/ssl/qssldiffiehellmanparameters.cpp | 11 ++++++----- src/widgets/kernel/qapplication.cpp | 24 ------------------------ 8 files changed, 26 insertions(+), 38 deletions(-) (limited to 'src') diff --git a/src/corelib/doc/src/animation.qdoc b/src/corelib/doc/src/animation.qdoc index 4e71ed4268..0c1b2aed17 100644 --- a/src/corelib/doc/src/animation.qdoc +++ b/src/corelib/doc/src/animation.qdoc @@ -121,7 +121,7 @@ As mentioned in the previous section, the QPropertyAnimation class can interpolate over Qt properties. It is often this class that should be used for animation of values; in fact, its superclass, QVariantAnimation, has an - empty implementation of \l{QAbstractAnimation::}{updateCurrentValue()}, and + empty implementation of \l{QVariantAnimation::}{updateCurrentValue()}, and does not change any value unless we change it ourselves on the \l{QVariantAnimation::valueChanged()}{valueChanged signal}. diff --git a/src/corelib/io/qdatastream.cpp b/src/corelib/io/qdatastream.cpp index de1fc18cd0..b4eb98e062 100644 --- a/src/corelib/io/qdatastream.cpp +++ b/src/corelib/io/qdatastream.cpp @@ -556,6 +556,7 @@ void QDataStream::setByteOrder(ByteOrder bo) \value Qt_5_5 Same as Qt_5_4 \value Qt_5_6 Version 17 (Qt 5.6) \value Qt_5_7 Same as Qt_5_6 + \value Qt_5_8 Same as Qt_5_6 \omitvalue Qt_DefaultCompiledVersion \sa setVersion(), version() diff --git a/src/corelib/tools/qcommandlineoption.cpp b/src/corelib/tools/qcommandlineoption.cpp index 1f7f9cc33b..7482315909 100644 --- a/src/corelib/tools/qcommandlineoption.cpp +++ b/src/corelib/tools/qcommandlineoption.cpp @@ -433,7 +433,7 @@ QCommandLineOption::Flags QCommandLineOption::flags() const } /*! - Set the set of flags that affect this command-line option. + Set the set of flags that affect this command-line option to \a flags. \since 5.8 \sa flags(), QCommandLineOption::Flags diff --git a/src/corelib/tools/qdatetime.cpp b/src/corelib/tools/qdatetime.cpp index adb539c388..57de7a8f6e 100644 --- a/src/corelib/tools/qdatetime.cpp +++ b/src/corelib/tools/qdatetime.cpp @@ -4261,6 +4261,16 @@ bool QDateTime::operator<(const QDateTime &other) const \sa currentDateTime(), currentDateTimeUtc(), toTime_t(), toTimeSpec() */ +/*! + \fn qint64 QDateTime::currentSecsSinceEpoch() + \since 5.8 + + Returns the number of seconds since 1970-01-01T00:00:00 Universal + Coordinated Time. + + \sa currentMSecsSinceEpoch() +*/ + #if defined(Q_OS_WIN) static inline uint msecsFromDecomposed(int hour, int minute, int sec, int msec = 0) { diff --git a/src/corelib/tools/qstring.cpp b/src/corelib/tools/qstring.cpp index 8cabb3c5d2..55390189b6 100644 --- a/src/corelib/tools/qstring.cpp +++ b/src/corelib/tools/qstring.cpp @@ -8338,7 +8338,7 @@ QString &QString::setRawData(const QChar *unicode, int size) \a start in this object. \note This function performs no error checking. - The behavior is undefined when \a start < 0, \length < 0, + The behavior is undefined when \a start < 0, \a length < 0, or \a start + \a length > size(). \sa left(), right() @@ -8351,7 +8351,7 @@ QString &QString::setRawData(const QChar *unicode, int size) 0 in this object. \note This function performs no error checking. - The behavior is undefined when \length < 0 or \a length > size(). + The behavior is undefined when \a length < 0 or \a length > size(). \sa mid(), right() */ @@ -8363,7 +8363,7 @@ QString &QString::setRawData(const QChar *unicode, int size) size() - \a length in this object. \note This function performs no error checking. - The behavior is undefined when \length < 0 or \a length > size(). + The behavior is undefined when \a length < 0 or \a length > size(). \sa mid(), left() */ diff --git a/src/network/ssl/qsslconfiguration.cpp b/src/network/ssl/qsslconfiguration.cpp index e009824a69..bc8394afdc 100644 --- a/src/network/ssl/qsslconfiguration.cpp +++ b/src/network/ssl/qsslconfiguration.cpp @@ -830,9 +830,9 @@ QByteArray QSslConfiguration::preSharedKeyIdentityHint() const /*! \since 5.8 - Sets the identity hint for a preshared key authentication. This will affect the next - initiated handshake; calling this function on an already-encrypted socket - will not affect the socket's identity hint. + Sets the identity hint for a preshared key authentication to \a hint. This will + affect the next initiated handshake; calling this function on an already-encrypted + socket will not affect the socket's identity hint. The identity hint is used in QSslSocket::SslServerMode only! */ @@ -858,7 +858,7 @@ QSslDiffieHellmanParameters QSslConfiguration::diffieHellmanParameters() const \since 5.8 Sets a custom set of Diffie-Hellman parameters to be used by this socket when functioning as - a server. + a server to \a dhparams. If no Diffie-Hellman parameters have been set, the QSslConfiguration object defaults to using the 1024-bit MODP group from RFC 2409. diff --git a/src/network/ssl/qssldiffiehellmanparameters.cpp b/src/network/ssl/qssldiffiehellmanparameters.cpp index d411ea0a5d..e6a2fe8a2a 100644 --- a/src/network/ssl/qssldiffiehellmanparameters.cpp +++ b/src/network/ssl/qssldiffiehellmanparameters.cpp @@ -104,7 +104,7 @@ QSslDiffieHellmanParameters::QSslDiffieHellmanParameters() /*! Constructs a QSslDiffieHellmanParameters object using - the byte array \a encoded in either PEM or DER form. + the byte array \a encoded in either PEM or DER form as specified by \a encoding. After construction, the isValid() method should be used to check whether the Diffie-Hellman parameters were valid and @@ -214,7 +214,6 @@ bool QSslDiffieHellmanParameters::isEmpty() const Q_DECL_NOTHROW If a QSslDiffieHellmanParameters object is not valid, you can use the error() method to determine what error prevented the object from being constructed. - \sa clear() \sa error() */ bool QSslDiffieHellmanParameters::isValid() const Q_DECL_NOTHROW @@ -227,11 +226,13 @@ bool QSslDiffieHellmanParameters::isValid() const Q_DECL_NOTHROW Describes a QSslDiffieHellmanParameters error. - \value ErrorInvalidInputData The given input data could not be used to + \value NoError No error occurred. + + \value InvalidInputDataError The given input data could not be used to construct a QSslDiffieHellmanParameters object. - \value ErrorUnsafeParameters The Diffie-Hellman parameters are unsafe + \value UnsafeParametersError The Diffie-Hellman parameters are unsafe and should not be used. */ @@ -277,7 +278,7 @@ bool operator==(const QSslDiffieHellmanParameters &lhs, const QSslDiffieHellmanP /*! \relates QSslDiffieHellmanParameters - Writes the set of Diffie-Hellman parameters in \a dhparm into the debug object \a debug for + Writes the set of Diffie-Hellman parameters in \a dhparam into the debug object \a debug for debugging purposes. The Diffie-Hellman parameters will be represented in Base64-encoded DER form. diff --git a/src/widgets/kernel/qapplication.cpp b/src/widgets/kernel/qapplication.cpp index 5007969c96..d070907977 100644 --- a/src/widgets/kernel/qapplication.cpp +++ b/src/widgets/kernel/qapplication.cpp @@ -996,30 +996,6 @@ bool QApplication::compressEvent(QEvent *event, QObject *receiver, QPostEventLis \sa QWidget::setStyle(), {Qt Style Sheets} */ -/*! - \property QApplication::autoMaximizeThreshold - \since 4.4 - \brief defines a threshold for auto maximizing widgets - - \b{The auto maximize threshold is only available as part of Qt for - Windows CE.} - - This property defines a threshold for the size of a window as a percentage - of the screen size. If the minimum size hint of a window exceeds the - threshold, calling show() will cause the window to be maximized - automatically. - - Setting the threshold to 100 or greater means that the widget will always - be maximized. Alternatively, setting the threshold to 50 means that the - widget will be maximized only if the vertical minimum size hint is at least - 50% of the vertical screen size. - - Setting the threshold to -1 disables the feature. - - On Windows CE the default is -1 (i.e., it is disabled). - On Windows Mobile the default is 40. -*/ - /*! \property QApplication::autoSipEnabled \since 4.5 -- cgit v1.2.3