QtGui/Network/OpenGl/Widgets/Xml: use \nullptr in documentation

Replace null and '\c nullptr' with \nullptr in the documentation.

Change-Id: I58934eea06943309ba895833f1991629870ab45b
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
This commit is contained in:
Christian Ehrlicher 2019-02-15 21:27:58 +01:00
parent da4ab444ff
commit a4b8e7141b
23 changed files with 70 additions and 62 deletions

View File

@ -439,7 +439,7 @@ void QClipboard::setPixmap(const QPixmap &pixmap, Mode mode)
\fn QMimeData *QClipboard::mimeData(Mode mode) const
Returns a pointer to a QMimeData representation of the current
clipboard data (can be NULL if the given \a mode is not
clipboard data (can be \nullptr if the given \a mode is not
supported by the platform).
The \a mode argument is used to control which part of the system

View File

@ -1023,7 +1023,7 @@ QList<QScreen *> QGuiApplication::screens()
}
/*!
Returns the screen at \a point, or \c nullptr if outside of any screen.
Returns the screen at \a point, or \nullptr if outside of any screen.
The \a point is in relation to the virtualGeometry() of each set of virtual
siblings. If the point maps to more than one set of virtual siblings the first

View File

@ -1235,7 +1235,8 @@ void QOpenGLContext::deleteQGLContext()
Returns the platform-specific handle for the OpenGL implementation that
is currently in use. (for example, a HMODULE on Windows)
On platforms that do not use dynamic GL switch the return value is null.
On platforms that do not use dynamic GL switching, the return value
is \nullptr.
The library might be GL-only, meaning that windowing system interface
functions (for example EGL) may live in another, separate library.

View File

@ -291,7 +291,7 @@ QPlatformPixmap *QPlatformIntegration::createPlatformPixmap(QPlatformPixmap::Pix
platform implementation is responsible for querying the configuriation from the provided
native context.
Returns a pointer to a QPlatformOpenGLContext instance or \c NULL if the context could
Returns a pointer to a QPlatformOpenGLContext instance or \nullptr if the context could
not be created.
\sa QOpenGLContext
@ -647,7 +647,7 @@ void QPlatformIntegration::setApplicationIcon(const QIcon &icon) const
pointer to the instance for which a platform-specific backend needs to be
created.
Returns a pointer to a QPlatformOpenGLContext instance or \c NULL if the context could
Returns a pointer to a QPlatformOpenGLContext instance or \nullptr if the context could
not be created.
\sa QVulkanInstance

View File

@ -175,7 +175,7 @@ int QShortcutMap::addShortcut(QObject *owner, const QKeySequence &key, Qt::Short
/*! \internal
Removes a shortcut from the global map.
If \a owner is 0, all entries in the map with the key sequence specified
If \a owner is \nullptr, all entries in the map with the key sequence specified
is removed. If \a key is null, all sequences for \a owner is removed from
the map. If \a id is 0, any identical \a key sequences owned by \a owner
are removed.
@ -222,7 +222,7 @@ int QShortcutMap::removeShortcut(int id, QObject *owner, const QKeySequence &key
/*! \internal
Changes the enable state of a shortcut to \a enable.
If \a owner is 0, all entries in the map with the key sequence specified
If \a owner is \nullptr, all entries in the map with the key sequence specified
is removed. If \a key is null, all sequences for \a owner is removed from
the map. If \a id is 0, any identical \a key sequences owned by \a owner
are changed.
@ -260,7 +260,7 @@ int QShortcutMap::setShortcutEnabled(bool enable, int id, QObject *owner, const
/*! \internal
Changes the auto repeat state of a shortcut to \a enable.
If \a owner is 0, all entries in the map with the key sequence specified
If \a owner is \nullptr, all entries in the map with the key sequence specified
is removed. If \a key is null, all sequences for \a owner is removed from
the map. If \a id is 0, any identical \a key sequences owned by \a owner
are changed.

View File

@ -206,7 +206,8 @@ QOpenGLFunctions::QOpenGLFunctions()
/*!
Constructs a function resolver for \a context. If \a context
is null, then the resolver will be created for the current QOpenGLContext.
is \nullptr, then the resolver will be created for the current
QOpenGLContext.
The context or another context in the group must be current.
@ -5035,8 +5036,8 @@ QOpenGLExtraFunctions::QOpenGLExtraFunctions()
}
/*!
Constructs a function resolver for context. If \a context is null, then
the resolver will be created for the current QOpenGLContext.
Constructs a function resolver for context. If \a context is \nullptr,
then the resolver will be created for the current QOpenGLContext.
The context or another context in the group must be current.

View File

@ -3667,7 +3667,8 @@ QVector<float> QOpenGLShaderProgram::defaultInnerTessellationLevels() const
Language (GLSL) are supported on this system; false otherwise.
The \a context is used to resolve the GLSL extensions.
If \a context is null, then QOpenGLContext::currentContext() is used.
If \a context is \nullptr, then QOpenGLContext::currentContext()
is used.
*/
bool QOpenGLShaderProgram::hasOpenGLShaderPrograms(QOpenGLContext *context)
{
@ -3694,7 +3695,8 @@ void QOpenGLShaderProgram::shaderDestroyed()
this system; false otherwise.
The \a context is used to resolve the GLSL extensions.
If \a context is null, then QOpenGLContext::currentContext() is used.
If \a context is \nullptr, then QOpenGLContext::currentContext()
is used.
*/
bool QOpenGLShader::hasOpenGLShaders(ShaderType type, QOpenGLContext *context)
{

View File

@ -208,7 +208,7 @@ static bool isRasterSurface(QWindow *window)
The \a window must either be the top level window represented by
this backingstore, or a non-transient child of that window. Passing
\c nullptr falls back to using the backingstore's top level window.
\nullptr falls back to using the backingstore's top level window.
If the \a window is a child window, the \a region should be in child window
coordinates, and the \a offset should be the child window's offset in relation

View File

@ -1022,8 +1022,8 @@ void QFontEngine::getUnscaledGlyph(glyph_t glyph, QPainterPath *path, glyph_metr
Returns \c true if the font table idetified by \a tag exists in the font;
returns \c false otherwise.
If \a buffer is NULL, stores the size of the buffer required for the font table data,
in bytes, in \a length. If \a buffer is not NULL and the capacity
If \a buffer is \nullptr, stores the size of the buffer required for the font table data,
in bytes, in \a length. If \a buffer is not \nullptr and the capacity
of the buffer, passed in \a length, is sufficient to store the font table data,
also copies the font table data to \a buffer.

View File

@ -306,7 +306,7 @@ QVulkanInstance::QVulkanInstance()
/*!
Destructor.
\note current() will return \c nullptr once the instance is destroyed.
\note current() will return \nullptr once the instance is destroyed.
*/
QVulkanInstance::~QVulkanInstance()
{

View File

@ -1826,8 +1826,8 @@ int QFtp::cd(const QString &dir)
is data available to read. You can then read the data with the
read() or readAll() functions.
If \a dev is not 0, the data is written directly to the device \a
dev. Make sure that the \a dev pointer is valid for the duration
If \a dev is not \nullptr, the data is written directly to the device
\a dev. Make sure that the \a dev pointer is valid for the duration
of the operation (it is safe to delete it when the
commandFinished() signal is emitted). In this case the readyRead()
signal is \e not emitted and you cannot read data with the

View File

@ -506,8 +506,8 @@ void QLocalServer::setMaxPendingConnections(int numConnections)
/*!
Waits for at most \a msec milliseconds or until an incoming connection
is available. Returns \c true if a connection is available; otherwise
returns \c false. If the operation timed out and \a timedOut is not 0,
*timedOut will be set to true.
returns \c false. If the operation timed out and \a timedOut is not
\nullptr, *timedOut will be set to true.
This is a blocking function call. Its use is ill-advised in a
single-threaded GUI application, since the whole application will stop

View File

@ -999,8 +999,8 @@ void QNativeSocketEngine::close()
/*!
Waits for \a msecs milliseconds or until the socket is ready for
reading. If \a timedOut is not 0 and \a msecs milliseconds have
passed, the value of \a timedOut is set to true.
reading. If \a timedOut is not \nullptr and \a msecs milliseconds
have passed, the value of \a timedOut is set to true.
Returns \c true if data is available for reading; otherwise returns
false.
@ -1039,8 +1039,8 @@ bool QNativeSocketEngine::waitForRead(int msecs, bool *timedOut)
/*!
Waits for \a msecs milliseconds or until the socket is ready for
writing. If \a timedOut is not 0 and \a msecs milliseconds have
passed, the value of \a timedOut is set to true.
writing. If \a timedOut is not \nullptr and \a msecs milliseconds
have passed, the value of \a timedOut is set to true.
Returns \c true if data is available for writing; otherwise returns
false.

View File

@ -493,7 +493,7 @@ QHostAddress QTcpServer::serverAddress() const
Waits for at most \a msec milliseconds or until an incoming
connection is available. Returns \c true if a connection is
available; otherwise returns \c false. If the operation timed out
and \a timedOut is not 0, *\a timedOut will be set to true.
and \a timedOut is not \nullptr, *\a timedOut will be set to true.
This is a blocking function call. Its use is disadvised in a
single-threaded GUI application, since the whole application will

View File

@ -136,7 +136,7 @@ QSslDiffieHellmanParameters QSslDiffieHellmanParameters::fromEncoded(const QByte
to check whether the Diffie-Hellman parameters were valid
and loaded correctly.
In particular, if \a device is \c nullptr or not open for reading, an invalid
In particular, if \a device is \nullptr or not open for reading, an invalid
object will be returned.
\sa isValid()

View File

@ -170,7 +170,8 @@ QGLFunctions::QGLFunctions()
/*!
Constructs a function resolver for \a context. If \a context
is null, then the resolver will be created for the current QGLContext.
is \nullptr, then the resolver will be created for the current
QGLContext.
An object constructed in this way can only be used with \a context
and other contexts that share with it. Use initializeGLFunctions()
@ -305,7 +306,7 @@ bool QGLFunctions::hasOpenGLFeature(QGLFunctions::OpenGLFeature feature) const
/*!
Initializes GL function resolution for \a context. If \a context
is null, then the current QGLContext will be used.
is \nullptr, then the current QGLContext will be used.
After calling this function, the QGLFunctions object can only be
used with \a context and other contexts that share with it.

View File

@ -3169,7 +3169,8 @@ GLenum QGLShaderProgram::geometryOutputType() const
Language (GLSL) are supported on this system; false otherwise.
The \a context is used to resolve the GLSL extensions.
If \a context is null, then QGLContext::currentContext() is used.
If \a context is \nullptr, then QGLContext::currentContext() is
used.
*/
bool QGLShaderProgram::hasOpenGLShaderPrograms(const QGLContext *context)
{
@ -3207,7 +3208,8 @@ void QGLShaderProgram::shaderDestroyed()
this system; false otherwise.
The \a context is used to resolve the GLSL extensions.
If \a context is null, then QGLContext::currentContext() is used.
If \a context is \nullptr, then QGLContext::currentContext() is
used.
\since 4.7
*/

View File

@ -63,7 +63,7 @@
Constructs a new QSignalSpy that listens for emissions of the \a signal
from the QObject \a object. If QSignalSpy is not able to listen for a
valid signal (for example, because \a object is null or \a signal does
valid signal (for example, because \a object is \nullptr or \a signal does
not denote a valid signal of \a object), an explanatory warning message
will be output using qWarning() and subsequent calls to \c isValid() will
return false.
@ -77,7 +77,7 @@
Constructs a new QSignalSpy that listens for emissions of the \a signal
from the QObject \a object. If QSignalSpy is not able to listen for a
valid signal (for example, because \a object is null or \a signal does
valid signal (for example, because \a object is \nullptr or \a signal does
not denote a valid signal of \a object), an explanatory warning message
will be output using qWarning() and subsequent calls to \c isValid() will
return false.

View File

@ -2129,8 +2129,8 @@ QString QFileDialog::labelText(DialogLabel label) const
\snippet code/src_gui_dialogs_qfiledialog.cpp 8
The function creates a modal file dialog with the given \a parent widget.
If \a parent is not 0, the dialog will be shown centered over the parent
widget.
If \a parent is not \nullptr, the dialog will be shown centered over the
parent widget.
The file dialog's working directory will be set to \a dir. If \a dir
includes a file name, the file will be selected. Only files that match the
@ -2152,8 +2152,8 @@ QString QFileDialog::labelText(DialogLabel label) const
native file dialog and not a QFileDialog.
On Windows the dialog will spin a blocking modal event loop that will not
dispatch any QTimers, and if \a parent is not 0 then it will position the
dialog just below the parent's title bar.
dispatch any QTimers, and if \a parent is not \nullptr then it will position
the dialog just below the parent's title bar.
On Unix/X11, the normal behavior of the file dialog is to resolve and
follow symlinks. For example, if \c{/usr/tmp} is a symlink to \c{/var/tmp},
@ -2242,8 +2242,8 @@ QUrl QFileDialog::getOpenFileUrl(QWidget *parent,
\snippet code/src_gui_dialogs_qfiledialog.cpp 9
This function creates a modal file dialog with the given \a parent widget.
If \a parent is not 0, the dialog will be shown centered over the parent
widget.
If \a parent is not \nullptr, the dialog will be shown centered over the
parent widget.
The file dialog's working directory will be set to \a dir. If \a dir
includes a file name, the file will be selected. The filter is set to
@ -2261,8 +2261,8 @@ QUrl QFileDialog::getOpenFileUrl(QWidget *parent,
native file dialog and not a QFileDialog.
On Windows the dialog will spin a blocking modal event loop that will not
dispatch any QTimers, and if \a parent is not 0 then it will position the
dialog just below the parent's title bar.
dispatch any QTimers, and if \a parent is not \nullptr then it will position
the dialog just below the parent's title bar.
On Unix/X11, the normal behavior of the file dialog is to resolve and
follow symlinks. For example, if \c{/usr/tmp} is a symlink to \c{/var/tmp},
@ -2434,8 +2434,8 @@ void QFileDialog::getOpenFileContent(const QString &nameFilter, const std::funct
by the user. The file does not have to exist.
It creates a modal file dialog with the given \a parent widget. If
\a parent is not 0, the dialog will be shown centered over the parent
widget.
\a parent is not \nullptr, the dialog will be shown centered over the
parent widget.
\snippet code/src_gui_dialogs_qfiledialog.cpp 11
@ -2461,9 +2461,9 @@ void QFileDialog::getOpenFileContent(const QString &nameFilter, const std::funct
native file dialog and not a QFileDialog.
On Windows the dialog will spin a blocking modal event loop that will not
dispatch any QTimers, and if \a parent is not 0 then it will position the
dialog just below the parent's title bar. On \macos, with its native file
dialog, the filter argument is ignored.
dispatch any QTimers, and if \a parent is not \nullptr then it will
position the dialog just below the parent's title bar. On \macos, with its
native file dialog, the filter argument is ignored.
On Unix/X11, the normal behavior of the file dialog is to resolve and
follow symlinks. For example, if \c{/usr/tmp} is a symlink to \c{/var/tmp},
@ -2553,8 +2553,8 @@ QUrl QFileDialog::getSaveFileUrl(QWidget *parent,
\snippet code/src_gui_dialogs_qfiledialog.cpp 12
This function creates a modal file dialog with the given \a parent widget.
If \a parent is not 0, the dialog will be shown centered over the parent
widget.
If \a parent is not \nullptr, the dialog will be shown centered over the
parent widget.
The dialog's working directory is set to \a dir, and the caption is set to
\a caption. Either of these may be an empty string in which case the
@ -2578,8 +2578,8 @@ QUrl QFileDialog::getSaveFileUrl(QWidget *parent,
symlinks as regular directories.
On Windows, the dialog will spin a blocking modal event loop that will not
dispatch any QTimers, and if \a parent is not 0 then it will position the
dialog just below the parent's title bar.
dispatch any QTimers, and if \a parent is not \nullptr then it will position
the dialog just below the parent's title bar.
\warning Do not delete \a parent during the execution of the dialog. If you
want to do this, you should create the dialog yourself using one of the

View File

@ -109,7 +109,7 @@ static int menuBarHeightForWidth(QWidget *menubar, int w)
/*!
Constructs a new top-level QLayout, with parent \a parent.
\a parent may not be a \c nullptr.
\a parent may not be a \nullptr.
The layout is set directly as the top-level layout for
\a parent. There can be only one top-level layout for a

View File

@ -102,9 +102,9 @@ QT_BEGIN_NAMESPACE
/*!
Constructs a QUndoCommand object with the given \a parent and \a text.
If \a parent is not 0, this command is appended to parent's child list.
The parent command then owns this command and will delete it in its
destructor.
If \a parent is not \nullptr, this command is appended to parent's
child list. The parent command then owns this command and will delete
it in its destructor.
\sa ~QUndoCommand()
*/
@ -118,9 +118,9 @@ QUndoCommand::QUndoCommand(const QString &text, QUndoCommand *parent)
/*!
Constructs a QUndoCommand object with parent \a parent.
If \a parent is not 0, this command is appended to parent's child list.
The parent command then owns this command and will delete it in its
destructor.
If \a parent is not \nullptr, this command is appended to parent's
child list. The parent command then owns this command and will delete
it in its destructor.
\sa ~QUndoCommand()
*/

View File

@ -1232,7 +1232,7 @@ QSplitterHandle *QSplitter::createHandle()
/*!
Returns the handle to the left of (or above) the item in the
splitter's layout at the given \a index, or \c nullptr if there is no such item.
splitter's layout at the given \a index, or \nullptr if there is no such item.
The handle at index 0 is always hidden.
For right-to-left languages such as Arabic and Hebrew, the layout
@ -1251,7 +1251,7 @@ QSplitterHandle *QSplitter::handle(int index) const
/*!
Returns the widget at the given \a index in the splitter's layout,
or \c nullptr if there is no such widget.
or \nullptr if there is no such widget.
\sa count(), handle(), indexOf(), insertWidget()
*/

View File

@ -2613,8 +2613,9 @@ void QXmlSimpleReaderPrivate::initIncrementalParsing()
is returned. If no such feature exists the return value is
undefined.
If \a ok is not 0: \c{*}\a{ok} is set to true if the reader has the
feature called \a name; otherwise \c{*}\a{ok} is set to false.
If \a ok is not \nullptr: \c{*}\a{ok} is set to true if the
reader has the feature called \a name; otherwise \c{*}\a{ok} is
set to false.
\sa setFeature(), hasFeature()
*/
@ -2643,7 +2644,7 @@ void QXmlSimpleReaderPrivate::initIncrementalParsing()
If the reader has the property \a name, this function returns the
value of the property; otherwise the return value is undefined.
If \a ok is not 0: if the reader has the \a name property
If \a ok is not \nullptr: if the reader has the \a name property
\c{*}\a{ok} is set to true; otherwise \c{*}\a{ok} is set to false.
\sa setProperty(), hasProperty()