diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2020-08-19 14:54:51 +0200 |
---|---|---|
committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2020-08-20 07:51:05 +0200 |
commit | 92d4d490fe808479e3fe8885e5e5cabd20f3d03f (patch) | |
tree | bed5c974344f0baac00265c48f4d674ad185e557 /src/corelib/kernel | |
parent | 1f1f0003274e446fc49e61255749f83c5826cd0b (diff) |
Fix a number of qdoc warnings
- Remove obsolete functions and enumeration values
- Remove QObject * parameter from QMetaProperty accessors
- Fix renamed enumerations in QSsl
- Fix list items to be \li
- Fix function signatures and variable names
Change-Id: I37c7e6bf2c8ff92bc7b82620bae0a27796f866ab
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/corelib/kernel')
-rw-r--r-- | src/corelib/kernel/qabstracteventdispatcher.cpp | 27 | ||||
-rw-r--r-- | src/corelib/kernel/qcoreapplication.cpp | 20 | ||||
-rw-r--r-- | src/corelib/kernel/qmetaobject.cpp | 29 | ||||
-rw-r--r-- | src/corelib/kernel/qobject.cpp | 27 | ||||
-rw-r--r-- | src/corelib/kernel/qvariant.cpp | 8 |
5 files changed, 12 insertions, 99 deletions
diff --git a/src/corelib/kernel/qabstracteventdispatcher.cpp b/src/corelib/kernel/qabstracteventdispatcher.cpp index 72504a178d..9f655a50d8 100644 --- a/src/corelib/kernel/qabstracteventdispatcher.cpp +++ b/src/corelib/kernel/qabstracteventdispatcher.cpp @@ -248,24 +248,6 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread) */ /*! - \obsolete - - \fn int QAbstractEventDispatcher::registerTimer(int interval, QObject *object) - - Registers a timer with the specified \a interval for the given \a object - and returns the timer id. -*/ - -/*! - \obsolete - - \fn void QAbstractEventDispatcher::registerTimer(int timerId, int interval, QObject *object) - - Register a timer with the specified \a timerId and \a interval for the - given \a object. -*/ - -/*! Registers a timer with the specified \a interval and \a timerType for the given \a object and returns the timer id. */ @@ -495,15 +477,6 @@ bool QAbstractEventDispatcher::filterNativeEvent(const QByteArray &eventType, vo return false; } -/*! \fn bool QAbstractEventDispatcher::filterEvent(void *message) - \deprecated - - Calls filterNativeEvent() with an empty eventType and \a message. - This function returns \c true as soon as an - event filter returns \c true, and false otherwise to indicate that - the processing of the event should continue. -*/ - /*! \fn bool QAbstractEventDispatcher::registerEventNotifier(QWinEventNotifier *notifier) This pure virtual method exists on windows only and has to be reimplemented by a Windows specific diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp index 728ac6e7c1..303190ae69 100644 --- a/src/corelib/kernel/qcoreapplication.cpp +++ b/src/corelib/kernel/qcoreapplication.cpp @@ -1929,21 +1929,6 @@ bool QCoreApplication::event(QEvent *e) return QObject::event(e); } -/*! \enum QCoreApplication::Encoding - \obsolete - - This enum type used to define the 8-bit encoding of character string - arguments to translate(). This enum is now obsolete and UTF-8 will be - used in all cases. - - \value UnicodeUTF8 UTF-8. - \omitvalue Latin1 - \omitvalue DefaultCodec \omit UTF-8. \endomit - \omitvalue CodecForTr - - \sa QObject::tr(), QString::fromUtf8() -*/ - void QCoreApplicationPrivate::ref() { quitLockRef.ref(); @@ -2178,11 +2163,6 @@ QString QCoreApplication::translate(const char *context, const char *sourceText, return result; } -/*! \fn static QString QCoreApplication::translate(const char *context, const char *key, const char *disambiguation, Encoding encoding, int n = -1) - - \obsolete -*/ - // Declared in qglobal.h QString qtTrId(const char *id, int n) { diff --git a/src/corelib/kernel/qmetaobject.cpp b/src/corelib/kernel/qmetaobject.cpp index 6cb43cea72..09297e4c2e 100644 --- a/src/corelib/kernel/qmetaobject.cpp +++ b/src/corelib/kernel/qmetaobject.cpp @@ -3389,12 +3389,8 @@ bool QMetaProperty::isWritable() const /*! - Returns \c true if this property is designable; - otherwise returns \c false. - - If no \a object is given, the function returns \c false if the - \c{Q_PROPERTY()}'s \c DESIGNABLE attribute is false; otherwise - returns \c true. + Returns \c false if the \c{Q_PROPERTY()}'s \c DESIGNABLE attribute + is false; otherwise returns \c true. \sa isScriptable(), isStored() */ @@ -3406,12 +3402,8 @@ bool QMetaProperty::isDesignable() const } /*! - Returns \c true if the property is scriptable; - otherwise returns \c false. - - If no \a object is given, the function returns \c false if the - \c{Q_PROPERTY()}'s \c SCRIPTABLE attribute is false; otherwise returns - true. + Returns \c false if the \c{Q_PROPERTY()}'s \c SCRIPTABLE attribute + is false; otherwise returns true. \sa isDesignable(), isStored() */ @@ -3440,15 +3432,10 @@ bool QMetaProperty::isStored() const } /*! - Returns \c true if this property is designated as the \c USER - property, i.e., the one that the user can edit or - that is significant in some other way. Otherwise it returns - false. e.g., the \c text property is the \c USER editable property - of a QLineEdit. - - If \a object is \nullptr, the function returns \c false if the \c - {Q_PROPERTY()}'s \c USER attribute is false. Otherwise it returns - true. + Returns \c false if the \c {Q_PROPERTY()}'s \c USER attribute is false. + Otherwise it returns true, indicating the property is designated as the + \c USER property, i.e., the one that the user can edit or + that is significant in some other way. \sa QMetaObject::userProperty(), isDesignable(), isScriptable() */ diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index b26bd0298e..4a3356d810 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -2274,33 +2274,6 @@ void QObject::deleteLater() \sa QCoreApplication::translate(), {Internationalization with Qt} */ -/*! - \fn QString QObject::trUtf8(const char *sourceText, const char *disambiguation, int n) - \reentrant - \obsolete - - Returns a translated version of \a sourceText, or - QString::fromUtf8(\a sourceText) if there is no appropriate - version. It is otherwise identical to tr(\a sourceText, \a - disambiguation, \a n). - - \warning This method is reentrant only if all translators are - installed \e before calling this method. Installing or removing - translators while performing translations is not supported. Doing - so will probably result in crashes or other undesirable behavior. - - \warning For portability reasons, we recommend that you use - escape sequences for specifying non-ASCII characters in string - literals to trUtf8(). For example: - - \snippet code/src_corelib_kernel_qobject.cpp 20 - - \sa tr(), QCoreApplication::translate(), {Internationalization with Qt} -*/ - - - - /***************************************************************************** Signals and slots *****************************************************************************/ diff --git a/src/corelib/kernel/qvariant.cpp b/src/corelib/kernel/qvariant.cpp index c0aea0e98d..bb37072dc8 100644 --- a/src/corelib/kernel/qvariant.cpp +++ b/src/corelib/kernel/qvariant.cpp @@ -3714,9 +3714,9 @@ bool QVariant::convert(const int type, void *ptr) const exceptions: \list - \i If both types are numeric types (integers and floatins point numbers) + \li If both types are numeric types (integers and floatins point numbers) Qt will compare those types using standard C++ type promotion rules. - \i If one type is numeric and the other one a QString, Qt will try to + \li If one type is numeric and the other one a QString, Qt will try to convert the QString to a matching numeric type and if successful compare those. \endlist @@ -3735,9 +3735,9 @@ bool QVariant::convert(const int type, void *ptr) const exceptions: \list - \i If both types are numeric types (integers and floatins point numbers) + \li If both types are numeric types (integers and floatins point numbers) Qt will compare those types using standard C++ type promotion rules. - \i If one type is numeric and the other one a QString, Qt will try to + \li If one type is numeric and the other one a QString, Qt will try to convert the QString to a matching numeric type and if successful compare those. \endlist |