Documentation: Start using the \nullptr macro

Task-number: PYSIDE-903
Change-Id: I0c4640eb20157673eabb131e8834e79cbbf95d5c
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Friedemann Kleint 2019-01-10 11:15:49 +01:00
parent 9e3c46961a
commit 84e15a609b
7 changed files with 16 additions and 18 deletions

View File

@ -1343,11 +1343,11 @@ bool QJSValue::hasOwnProperty(const QString &name) const
/*!
* If this QJSValue is a QObject, returns the QObject pointer
* that the QJSValue represents; otherwise, returns 0.
* that the QJSValue represents; otherwise, returns \nullptr.
*
* If the QObject that this QJSValue wraps has been deleted,
* this function returns 0 (i.e. it is possible for toQObject()
* to return 0 even when isQObject() returns true).
* this function returns \nullptr (i.e. it is possible for toQObject()
* to return \nullptr even when isQObject() returns true).
*
* \sa isQObject()
*/

View File

@ -756,12 +756,12 @@ QQmlComponent::QQmlComponent(QQmlComponentPrivate &dd, QObject *parent)
}
/*!
Create an object instance from this component. Returns 0 if creation
Create an object instance from this component. Returns \nullptr if creation
failed. \a context specifies the context within which to create the object
instance.
If \a context is 0 (the default), it will create the instance in the
engine' s \l {QQmlEngine::rootContext()}{root context}.
If \a context is \nullptr (the default), it will create the instance in the
\l {QQmlEngine::rootContext()}{root context} of the engine.
The ownership of the returned object instance is transferred to the caller.
@ -791,7 +791,7 @@ QObject *QQmlComponent::create(QQmlContext *context)
In general, programmers should use QQmlComponent::create() to create object
instances.
Create an object instance from this component. Returns 0 if creation
Create an object instance from this component. Returns \nullptr if creation
failed. \a publicContext specifies the context within which to create the object
instance.

View File

@ -1304,9 +1304,7 @@ void QQmlEngine::addImageProvider(const QString &providerId, QQmlImageProviderBa
}
/*!
Returns the image provider set for \a providerId.
Returns the provider if it was found; otherwise returns 0.
Returns the image provider set for \a providerId if found; otherwise returns \nullptr.
\sa QQuickImageProvider
*/

View File

@ -184,7 +184,7 @@ bool QQmlListReference::isValid() const
}
/*!
Returns the list property's object. Returns 0 if the reference is invalid.
Returns the list property's object. Returns \nullptr if the reference is invalid.
*/
QObject *QQmlListReference::object() const
{
@ -193,8 +193,8 @@ QObject *QQmlListReference::object() const
}
/*!
Returns the QMetaObject for the elements stored in the list property. Returns 0 if the reference
is invalid.
Returns the QMetaObject for the elements stored in the list property,
or \nullptr if the reference is invalid.
The QMetaObject can be used ahead of time to determine whether a given instance can be added
to a list.

View File

@ -4798,7 +4798,7 @@ QQuickItem *QQuickItem::nextItemInFocusChain(bool forward)
Returns the first visible child item found at point (\a x, \a y) within
the coordinate system of this item.
Returns 0 if there is no such item.
Returns \nullptr if there is no such item.
*/
QQuickItem *QQuickItem::childAt(qreal x, qreal y) const
{
@ -7222,7 +7222,7 @@ bool QQuickItem::isFocusScope() const
If this item is a focus scope, this returns the item in its focus chain
that currently has focus.
Returns 0 if this item is not a focus scope.
Returns \nullptr if this item is not a focus scope.
*/
QQuickItem *QQuickItem::scopedFocusItem() const
{
@ -8158,7 +8158,7 @@ bool QQuickItem::isTextureProvider() const
\fn QSGTextureProvider *QQuickItem::textureProvider() const
Returns the texture provider for an item. The default implementation
returns 0.
returns \nullptr.
This function may only be called on the rendering thread.
*/

View File

@ -388,7 +388,7 @@ QSGTexture::~QSGTexture()
it to a shader that operates on the texture coordinates 0-1 instead
of the texture subrect inside the atlas.
If the texture is not part of a texture atlas, this function returns 0.
If the texture is not part of a texture atlas, this function returns \nullptr.
Implementations of this function are recommended to return the same instance
for multiple calls to limit memory usage.

View File

@ -436,7 +436,7 @@ QPixmap QQuickImageProvider::requestPixmap(const QString &id, QSize *size, const
/*!
Implement this method to return the texture with \a id. The default
implementation returns 0.
implementation returns \nullptr.
The \a id is the requested image source, with the "image:" scheme and
provider identifier removed. For example, if the image \l{Image::}{source}