From 05d9195669216038569aff7cf2901bd8e7a71ceb Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Thu, 28 Mar 2019 16:06:16 +0100 Subject: Doc: Use the \nullptr macro instead of 0 This enables overriding the macro so that it translates to 'None' in the Qt for Python context. Change-Id: Ib3cecf57eeb0405a1929309b71e9f012a07f11cf Reviewed-by: Christian Ehrlicher --- src/corelib/animation/qabstractanimation.cpp | 2 +- src/corelib/codecs/qtextcodec.cpp | 2 +- src/corelib/kernel/qabstracteventdispatcher.cpp | 2 +- src/corelib/kernel/qcoreapplication.cpp | 2 +- src/corelib/kernel/qmetaobject.cpp | 4 ++-- src/corelib/kernel/qobject.cpp | 2 +- src/corelib/plugin/qlibrary.cpp | 8 ++++---- src/corelib/plugin/qpluginloader.cpp | 2 +- src/corelib/thread/qthread.cpp | 2 +- src/corelib/tools/qsharedpointer.cpp | 2 +- src/widgets/doc/src/widgets-and-layouts/styles.qdoc | 2 +- src/widgets/itemviews/qtablewidget.cpp | 2 +- 12 files changed, 16 insertions(+), 16 deletions(-) (limited to 'src') diff --git a/src/corelib/animation/qabstractanimation.cpp b/src/corelib/animation/qabstractanimation.cpp index 9dd81b2ecd..78b79e574a 100644 --- a/src/corelib/animation/qabstractanimation.cpp +++ b/src/corelib/animation/qabstractanimation.cpp @@ -1083,7 +1083,7 @@ QAbstractAnimation::State QAbstractAnimation::state() const /*! If this animation is part of a QAnimationGroup, this function returns a - pointer to the group; otherwise, it returns 0. + pointer to the group; otherwise, it returns \nullptr. \sa QAnimationGroup::addAnimation() */ diff --git a/src/corelib/codecs/qtextcodec.cpp b/src/corelib/codecs/qtextcodec.cpp index 466c575c3e..eb05446beb 100644 --- a/src/corelib/codecs/qtextcodec.cpp +++ b/src/corelib/codecs/qtextcodec.cpp @@ -1244,7 +1244,7 @@ QTextCodec *QTextCodec::codecForUtfText(const QByteArray &ba) \obsolete Returns the codec used by QObject::tr() on its argument. If this - function returns 0 (the default), tr() assumes Latin-1. + function returns \nullptr (the default), tr() assumes Latin-1. */ /*! diff --git a/src/corelib/kernel/qabstracteventdispatcher.cpp b/src/corelib/kernel/qabstracteventdispatcher.cpp index 8e1b560874..ea08ff571f 100644 --- a/src/corelib/kernel/qabstracteventdispatcher.cpp +++ b/src/corelib/kernel/qabstracteventdispatcher.cpp @@ -162,7 +162,7 @@ QAbstractEventDispatcher::~QAbstractEventDispatcher() Returns a pointer to the event dispatcher object for the specified \a thread. If \a thread is zero, the current thread is used. If no event dispatcher exists for the specified thread, this function - returns 0. + returns \nullptr. \b{Note:} If Qt is built without thread support, the \a thread argument is ignored. diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp index c637f0c1c9..6d7985c91b 100644 --- a/src/corelib/kernel/qcoreapplication.cpp +++ b/src/corelib/kernel/qcoreapplication.cpp @@ -2923,7 +2923,7 @@ bool QCoreApplication::hasPendingEvents() /*! Returns a pointer to the event dispatcher object for the main thread. If no - event dispatcher exists for the thread, this function returns 0. + event dispatcher exists for the thread, this function returns \nullptr. */ QAbstractEventDispatcher *QCoreApplication::eventDispatcher() { diff --git a/src/corelib/kernel/qmetaobject.cpp b/src/corelib/kernel/qmetaobject.cpp index 5de2717078..b8b5c0de46 100644 --- a/src/corelib/kernel/qmetaobject.cpp +++ b/src/corelib/kernel/qmetaobject.cpp @@ -349,7 +349,7 @@ bool QMetaObject::inherits(const QMetaObject *metaObject) const Q_DECL_NOEXCEPT \internal Returns \a obj if object \a obj inherits from this - meta-object; otherwise returns 0. + meta-object; otherwise returns \nullptr. */ QObject *QMetaObject::cast(QObject *obj) const { @@ -361,7 +361,7 @@ QObject *QMetaObject::cast(QObject *obj) const \internal Returns \a obj if object \a obj inherits from this - meta-object; otherwise returns 0. + meta-object; otherwise returns \nullptr. */ const QObject *QMetaObject::cast(const QObject *obj) const { diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index cf838b6947..a791d2e8b3 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -2342,7 +2342,7 @@ static void err_info_about_objects(const char * func, /*! Returns a pointer to the object that sent the signal, if called in - a slot activated by a signal; otherwise it returns 0. The pointer + a slot activated by a signal; otherwise it returns \nullptr. The pointer is valid only during the execution of the slot that calls this function from this object's thread context. diff --git a/src/corelib/plugin/qlibrary.cpp b/src/corelib/plugin/qlibrary.cpp index aa63ed1a6b..29ef697fe8 100644 --- a/src/corelib/plugin/qlibrary.cpp +++ b/src/corelib/plugin/qlibrary.cpp @@ -999,7 +999,7 @@ void QLibrary::setFileNameAndVersion(const QString &fileName, const QString &ver /*! Returns the address of the exported symbol \a symbol. The library is - loaded if necessary. The function returns 0 if the symbol could + loaded if necessary. The function returns \nullptr if the symbol could not be resolved or if the library could not be loaded. Example: @@ -1032,7 +1032,7 @@ QFunctionPointer QLibrary::resolve(const char *symbol) include the platform-specific file suffix; (see \l{fileName}). The library remains loaded until the application exits. - The function returns 0 if the symbol could not be resolved or if + The function returns \nullptr if the symbol could not be resolved or if the library could not be loaded. \sa resolve() @@ -1052,7 +1052,7 @@ QFunctionPointer QLibrary::resolve(const QString &fileName, const char *symbol) (see \l{fileName}). The library remains loaded until the application exits. \a verNum is ignored on Windows. - The function returns 0 if the symbol could not be resolved or if + The function returns \nullptr if the symbol could not be resolved or if the library could not be loaded. \sa resolve() @@ -1073,7 +1073,7 @@ QFunctionPointer QLibrary::resolve(const QString &fileName, int verNum, const ch (see \l{fileName}). The library remains loaded until the application exits. \a version is ignored on Windows. - The function returns 0 if the symbol could not be resolved or if + The function returns \nullptr if the symbol could not be resolved or if the library could not be loaded. \sa resolve() diff --git a/src/corelib/plugin/qpluginloader.cpp b/src/corelib/plugin/qpluginloader.cpp index 0f94bb6adf..00480198bd 100644 --- a/src/corelib/plugin/qpluginloader.cpp +++ b/src/corelib/plugin/qpluginloader.cpp @@ -174,7 +174,7 @@ QPluginLoader::~QPluginLoader() /*! Returns the root component object of the plugin. The plugin is - loaded if necessary. The function returns 0 if the plugin could + loaded if necessary. The function returns \nullptr if the plugin could not be loaded or if the root component object could not be instantiated. diff --git a/src/corelib/thread/qthread.cpp b/src/corelib/thread/qthread.cpp index b023ae9ed2..9f60de1f87 100644 --- a/src/corelib/thread/qthread.cpp +++ b/src/corelib/thread/qthread.cpp @@ -920,7 +920,7 @@ QThreadPrivate::~QThreadPrivate() \since 5.0 Returns a pointer to the event dispatcher object for the thread. If no event - dispatcher exists for the thread, this function returns 0. + dispatcher exists for the thread, this function returns \nullptr. */ QAbstractEventDispatcher *QThread::eventDispatcher() const { diff --git a/src/corelib/tools/qsharedpointer.cpp b/src/corelib/tools/qsharedpointer.cpp index a1caeeb135..6ab84cf3d8 100644 --- a/src/corelib/tools/qsharedpointer.cpp +++ b/src/corelib/tools/qsharedpointer.cpp @@ -875,7 +875,7 @@ \b without ensuring that it cannot get deleted. To have that guarantee, use toStrongRef(), which returns a QSharedPointer object. If this function can determine that the pointer has already been deleted, it - returns 0. + returns \nullptr. It is ok to obtain the value of the pointer and using that value itself, like for example in debugging statements: diff --git a/src/widgets/doc/src/widgets-and-layouts/styles.qdoc b/src/widgets/doc/src/widgets-and-layouts/styles.qdoc index a9d95bc02c..645da5bca2 100644 --- a/src/widgets/doc/src/widgets-and-layouts/styles.qdoc +++ b/src/widgets/doc/src/widgets-and-layouts/styles.qdoc @@ -286,7 +286,7 @@ QStyleOption to a subclass (e.g., QStyleOptionFocusRect). For safety, you can use qstyleoption_cast() to ensure that the pointer type is correct. If the object isn't of the right type, - qstyleoption_cast() returns 0. For example: + qstyleoption_cast() returns \nullptr. For example: \snippet code/doc_src_qt4-styles.cpp 0 diff --git a/src/widgets/itemviews/qtablewidget.cpp b/src/widgets/itemviews/qtablewidget.cpp index eee3e91ac3..d576d323c3 100644 --- a/src/widgets/itemviews/qtablewidget.cpp +++ b/src/widgets/itemviews/qtablewidget.cpp @@ -1813,7 +1813,7 @@ void QTableWidgetPrivate::_q_dataChanged(const QModelIndex &topLeft, \fn QTableWidgetItem *QTableWidget::itemAt(int ax, int ay) const Returns the item at the position equivalent to QPoint(\a{ax}, \a{ay}) in - the table widget's coordinate system, or returns 0 if the specified point + the table widget's coordinate system, or returns \nullptr if the specified point is not covered by an item in the table widget. \sa item() -- cgit v1.2.3