summaryrefslogtreecommitdiffstats
path: root/src/gui/kernel
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/gui/kernel
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff)
Doc: Adding mark-up to boolean default values.
Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/gui/kernel')
-rw-r--r--src/gui/kernel/qclipboard.cpp28
-rw-r--r--src/gui/kernel/qevent.cpp20
-rw-r--r--src/gui/kernel/qguiapplication.cpp24
-rw-r--r--src/gui/kernel/qkeysequence.cpp24
-rw-r--r--src/gui/kernel/qopenglcontext.cpp14
-rw-r--r--src/gui/kernel/qpalette.cpp20
-rw-r--r--src/gui/kernel/qplatforminputcontext.cpp6
-rw-r--r--src/gui/kernel/qplatformintegration.cpp4
-rw-r--r--src/gui/kernel/qplatformscreenpageflipper.cpp2
-rw-r--r--src/gui/kernel/qplatformsharedgraphicscache.cpp4
-rw-r--r--src/gui/kernel/qplatformsystemtrayicon_qpa.cpp4
-rw-r--r--src/gui/kernel/qplatformwindow.cpp4
-rw-r--r--src/gui/kernel/qscreen.cpp8
-rw-r--r--src/gui/kernel/qsessionmanager.cpp8
-rw-r--r--src/gui/kernel/qsurfaceformat.cpp12
-rw-r--r--src/gui/kernel/qwindow.cpp10
16 files changed, 96 insertions, 96 deletions
diff --git a/src/gui/kernel/qclipboard.cpp b/src/gui/kernel/qclipboard.cpp
index f0b1f16ba2..3c2d36ce86 100644
--- a/src/gui/kernel/qclipboard.cpp
+++ b/src/gui/kernel/qclipboard.cpp
@@ -475,8 +475,8 @@ void QClipboard::setPixmap(const QPixmap &pixmap, Mode mode)
/*!
- Returns true if the clipboard supports mouse selection; otherwise
- returns false.
+ Returns \c true if the clipboard supports mouse selection; otherwise
+ returns \c false.
*/
bool QClipboard::supportsSelection() const
{
@@ -484,8 +484,8 @@ bool QClipboard::supportsSelection() const
}
/*!
- Returns true if the clipboard supports a separate search buffer; otherwise
- returns false.
+ Returns \c true if the clipboard supports a separate search buffer; otherwise
+ returns \c false.
*/
bool QClipboard::supportsFindBuffer() const
{
@@ -493,8 +493,8 @@ bool QClipboard::supportsFindBuffer() const
}
/*!
- Returns true if this clipboard object owns the clipboard data;
- otherwise returns false.
+ Returns \c true if this clipboard object owns the clipboard data;
+ otherwise returns \c false.
*/
bool QClipboard::ownsClipboard() const
{
@@ -502,8 +502,8 @@ bool QClipboard::ownsClipboard() const
}
/*!
- Returns true if this clipboard object owns the mouse selection
- data; otherwise returns false.
+ Returns \c true if this clipboard object owns the mouse selection
+ data; otherwise returns \c false.
*/
bool QClipboard::ownsSelection() const
{
@@ -513,8 +513,8 @@ bool QClipboard::ownsSelection() const
/*!
\since 4.2
- Returns true if this clipboard object owns the find buffer data;
- otherwise returns false.
+ Returns \c true if this clipboard object owns the find buffer data;
+ otherwise returns \c false.
*/
bool QClipboard::ownsFindBuffer() const
{
@@ -524,15 +524,15 @@ bool QClipboard::ownsFindBuffer() const
/*!
\internal
\fn bool QClipboard::supportsMode(Mode mode) const;
- Returns true if the clipboard supports the clipboard mode speacified by \a mode;
- otherwise returns false.
+ Returns \c true if the clipboard supports the clipboard mode speacified by \a mode;
+ otherwise returns \c false.
*/
/*!
\internal
\fn bool QClipboard::ownsMode(Mode mode) const;
- Returns true if the clipboard supports the clipboard data speacified by \a mode;
- otherwise returns false.
+ Returns \c true if the clipboard supports the clipboard data speacified by \a mode;
+ otherwise returns \c false.
*/
/*!
diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp
index e11c4671e6..ef9a3a1225 100644
--- a/src/gui/kernel/qevent.cpp
+++ b/src/gui/kernel/qevent.cpp
@@ -1028,8 +1028,8 @@ Qt::KeyboardModifiers QKeyEvent::modifiers() const
\fn bool QKeyEvent::matches(QKeySequence::StandardKey key) const
\since 4.2
- Returns true if the key event matches the given standard \a key;
- otherwise returns false.
+ Returns \c true if the key event matches the given standard \a key;
+ otherwise returns \c false.
*/
bool QKeyEvent::matches(QKeySequence::StandardKey matchKey) const
{
@@ -1045,8 +1045,8 @@ bool QKeyEvent::matches(QKeySequence::StandardKey matchKey) const
/*!
\fn bool QKeyEvent::isAutoRepeat() const
- Returns true if this event comes from an auto-repeating key;
- returns false if it comes from an initial key press.
+ Returns \c true if this event comes from an auto-repeating key;
+ returns \c false if it comes from an initial key press.
Note that if the event is a multiple-key compressed event that is
partly due to auto-repeat, this function could return either true
@@ -1113,14 +1113,14 @@ Qt::FocusReason QFocusEvent::reason() const
/*!
\fn bool QFocusEvent::gotFocus() const
- Returns true if type() is QEvent::FocusIn; otherwise returns
+ Returns \c true if type() is QEvent::FocusIn; otherwise returns
false.
*/
/*!
\fn bool QFocusEvent::lostFocus() const
- Returns true if type() is QEvent::FocusOut; otherwise returns
+ Returns \c true if type() is QEvent::FocusOut; otherwise returns
false.
*/
@@ -1359,7 +1359,7 @@ QResizeEvent::~QResizeEvent()
If the last top-level window is closed, the
QApplication::lastWindowClosed() signal is emitted.
- The isAccepted() function returns true if the event's receiver has
+ The isAccepted() function returns \c true if the event's receiver has
agreed to close the widget; call accept() to agree to close the
widget and call ignore() if the receiver of this event does not
want the widget to be closed.
@@ -2875,7 +2875,7 @@ QActionEvent::~QActionEvent()
window manager controls, either by iconifying the window or by
switching to another virtual desktop where the window isn't
visible. The window will become hidden but not withdrawn. If the
- window was iconified, QWidget::isMinimized() returns true.
+ window was iconified, QWidget::isMinimized() returns \c true.
\sa QShowEvent
*/
@@ -2988,7 +2988,7 @@ QFileOpenEvent::~QFileOpenEvent()
\fn bool QFileOpenEvent::openFile(QFile &file, QIODevice::OpenMode flags) const
Opens a QFile on the \a file referenced by this event in the mode specified
- by \a flags. Returns true if successful; otherwise returns false.
+ by \a flags. Returns \c true if successful; otherwise returns \c false.
This is necessary as some files cannot be opened by name, but require specific
information stored in this event.
@@ -3428,7 +3428,7 @@ QDebug operator<<(QDebug dbg, const QEvent *e) {
/*!
\fn bool QShortcutEvent::isAmbiguous() const
- Returns true if the key sequence that triggered the event is
+ Returns \c true if the key sequence that triggered the event is
ambiguous.
\sa QShortcut::activatedAmbiguously()
diff --git a/src/gui/kernel/qguiapplication.cpp b/src/gui/kernel/qguiapplication.cpp
index c7eefdbefa..47efc98474 100644
--- a/src/gui/kernel/qguiapplication.cpp
+++ b/src/gui/kernel/qguiapplication.cpp
@@ -645,7 +645,7 @@ void QGuiApplicationPrivate::hideModalWindow(QWindow *window)
}
/*
- Returns true if \a window is blocked by a modal window. If \a
+ Returns \c true if \a window is blocked by a modal window. If \a
blockingWindow is non-zero, *blockingWindow will be set to the blocking
window (or to zero if \a window is not blocked).
*/
@@ -2520,8 +2520,8 @@ void QGuiApplication::setFont(const QFont &font)
/*!
\fn bool QGuiApplication::isRightToLeft()
- Returns true if the application's layout direction is
- Qt::RightToLeft; otherwise returns false.
+ Returns \c true if the application's layout direction is
+ Qt::RightToLeft; otherwise returns \c false.
\sa layoutDirection(), isLeftToRight()
*/
@@ -2529,8 +2529,8 @@ void QGuiApplication::setFont(const QFont &font)
/*!
\fn bool QGuiApplication::isLeftToRight()
- Returns true if the application's layout direction is
- Qt::LeftToRight; otherwise returns false.
+ Returns \c true if the application's layout direction is
+ Qt::LeftToRight; otherwise returns \c false.
\sa layoutDirection(), isRightToLeft()
*/
@@ -2552,7 +2552,7 @@ void QGuiApplicationPrivate::notifyActiveWindowChange(QWindow *)
The default is true.
- If this property is true, the applications quits when the last visible
+ If this property is \c true, the applications quits when the last visible
primary window (i.e. window with no parent) is closed.
\sa quit(), QWindow::close()
@@ -2720,8 +2720,8 @@ void QGuiApplicationPrivate::setApplicationState(Qt::ApplicationState state)
/*!
\fn bool QGuiApplication::isSessionRestored() const
- Returns true if the application has been restored from an earlier
- \l{Session Management}{session}; otherwise returns false.
+ Returns \c true if the application has been restored from an earlier
+ \l{Session Management}{session}; otherwise returns \c false.
\sa sessionId(), commitDataRequest(), saveStateRequest()
*/
@@ -2730,8 +2730,8 @@ void QGuiApplicationPrivate::setApplicationState(Qt::ApplicationState state)
\since 5.0
\fn bool QGuiApplication::isSavingSession() const
- Returns true if the application is currently saving the
- \l{Session Management}{session}; otherwise returns false.
+ Returns \c true if the application is currently saving the
+ \l{Session Management}{session}; otherwise returns \c false.
This is true when commitDataRequest() and saveStateRequest() are emitted,
but also when the windows are closed afterwards by session management.
@@ -3013,8 +3013,8 @@ void QGuiApplication::setDesktopSettingsAware(bool on)
}
/*!
- Returns true if Qt is set to use the system's standard colors, fonts, etc.;
- otherwise returns false. The default is true.
+ Returns \c true if Qt is set to use the system's standard colors, fonts, etc.;
+ otherwise returns \c false. The default is true.
\sa setDesktopSettingsAware()
*/
diff --git a/src/gui/kernel/qkeysequence.cpp b/src/gui/kernel/qkeysequence.cpp
index 1fcf1026d2..ead248074e 100644
--- a/src/gui/kernel/qkeysequence.cpp
+++ b/src/gui/kernel/qkeysequence.cpp
@@ -879,7 +879,7 @@ int QKeySequence::count() const
/*!
- Returns true if the key sequence is empty; otherwise returns
+ Returns \c true if the key sequence is empty; otherwise returns
false.
*/
bool QKeySequence::isEmpty() const
@@ -1372,14 +1372,14 @@ QKeySequence &QKeySequence::operator=(const QKeySequence &other)
/*!
\fn bool QKeySequence::operator!=(const QKeySequence &other) const
- Returns true if this key sequence is not equal to the \a other
- key sequence; otherwise returns false.
+ Returns \c true if this key sequence is not equal to the \a other
+ key sequence; otherwise returns \c false.
*/
/*!
- Returns true if this key sequence is equal to the \a other
- key sequence; otherwise returns false.
+ Returns \c true if this key sequence is equal to the \a other
+ key sequence; otherwise returns \c false.
*/
bool QKeySequence::operator==(const QKeySequence &other) const
{
@@ -1393,7 +1393,7 @@ bool QKeySequence::operator==(const QKeySequence &other) const
/*!
Provides an arbitrary comparison of this key sequence and
\a other key sequence. All that is guaranteed is that the
- operator returns false if both key sequences are equal and
+ operator returns \c false if both key sequences are equal and
that (ks1 \< ks2) == !( ks2 \< ks1) if the key sequences
are not equal.
@@ -1413,8 +1413,8 @@ bool QKeySequence::operator< (const QKeySequence &other) const
/*!
\fn bool QKeySequence::operator> (const QKeySequence &other) const
- Returns true if this key sequence is larger than the \a other key
- sequence; otherwise returns false.
+ Returns \c true if this key sequence is larger than the \a other key
+ sequence; otherwise returns \c false.
\sa operator==(), operator!=(), operator<(), operator<=(), operator>=()
*/
@@ -1422,8 +1422,8 @@ bool QKeySequence::operator< (const QKeySequence &other) const
/*!
\fn bool QKeySequence::operator<= (const QKeySequence &other) const
- Returns true if this key sequence is smaller or equal to the
- \a other key sequence; otherwise returns false.
+ Returns \c true if this key sequence is smaller or equal to the
+ \a other key sequence; otherwise returns \c false.
\sa operator==(), operator!=(), operator<(), operator>(), operator>=()
*/
@@ -1431,8 +1431,8 @@ bool QKeySequence::operator< (const QKeySequence &other) const
/*!
\fn bool QKeySequence::operator>= (const QKeySequence &other) const
- Returns true if this key sequence is larger or equal to the
- \a other key sequence; otherwise returns false.
+ Returns \c true if this key sequence is larger or equal to the
+ \a other key sequence; otherwise returns \c false.
\sa operator==(), operator!=(), operator<(), operator>(), operator<=()
*/
diff --git a/src/gui/kernel/qopenglcontext.cpp b/src/gui/kernel/qopenglcontext.cpp
index 9f03020c22..ab782fac34 100644
--- a/src/gui/kernel/qopenglcontext.cpp
+++ b/src/gui/kernel/qopenglcontext.cpp
@@ -184,7 +184,7 @@ void QOpenGLVersionProfile::setProfile(QSurfaceFormat::OpenGLContextProfile prof
}
/*!
- Returns true if profiles are supported by the OpenGL version returned by version(). Only
+ Returns \c true if profiles are supported by the OpenGL version returned by version(). Only
OpenGL versions >= 3.2 support profiles.
\sa profile(), version()
@@ -196,7 +196,7 @@ bool QOpenGLVersionProfile::hasProfiles() const
}
/*!
- Returns true is the OpenGL version returned by version() contains deprecated functions
+ Returns \c true is the OpenGL version returned by version() contains deprecated functions
and does not support profiles i.e. if the OpenGL version is <= 3.1.
*/
bool QOpenGLVersionProfile::isLegacyVersion() const
@@ -205,7 +205,7 @@ bool QOpenGLVersionProfile::isLegacyVersion() const
}
/*!
- Returns true if the version number is valid. Note that for a default constructed
+ Returns \c true if the version number is valid. Note that for a default constructed
QOpenGLVersionProfile object this function will return false.
\sa setVersion(), version()
@@ -380,7 +380,7 @@ QOpenGLContext* QOpenGLContext::currentContext()
}
/*!
- Returns true if the \a first and \a second contexts are sharing OpenGL resources.
+ Returns \c true if the \a first and \a second contexts are sharing OpenGL resources.
*/
bool QOpenGLContext::areSharing(QOpenGLContext *first, QOpenGLContext *second)
{
@@ -472,7 +472,7 @@ void QOpenGLContext::setScreen(QScreen *screen)
and/or hardware only supports version 3.2 Core profile contexts then you will
get a 3.2 Core profile context.
- Returns true if the native context was successfully created and is ready to
+ Returns \c true if the native context was successfully created and is ready to
be used with makeCurrent(), swapBuffers(), etc.
\sa makeCurrent(), destroy(), format()
@@ -698,7 +698,7 @@ QSet<QByteArray> QOpenGLContext::extensions() const
}
/*!
- Returns true if this OpenGL context supports the specified OpenGL
+ Returns \c true if this OpenGL context supports the specified OpenGL
\a extension, false otherwise.
The context or a sharing context must be current.
@@ -737,7 +737,7 @@ GLuint QOpenGLContext::defaultFramebufferObject() const
/*!
Makes the context current in the current thread, against the given
- \a surface. Returns true if successful.
+ \a surface. Returns \c true if successful.
If \a surface is 0 this is equivalent to calling doneCurrent().
diff --git a/src/gui/kernel/qpalette.cpp b/src/gui/kernel/qpalette.cpp
index 00ab74e4e4..f284c20af5 100644
--- a/src/gui/kernel/qpalette.cpp
+++ b/src/gui/kernel/qpalette.cpp
@@ -763,8 +763,8 @@ void QPalette::setBrush(ColorGroup cg, ColorRole cr, const QBrush &b)
/*!
\since 4.2
- Returns true if the ColorGroup \a cg and ColorRole \a cr has been
- set previously on this palette; otherwise returns false.
+ Returns \c true if the ColorGroup \a cg and ColorRole \a cr has been
+ set previously on this palette; otherwise returns \c false.
\sa setBrush()
*/
@@ -795,8 +795,8 @@ void QPalette::detach()
/*!
\fn bool QPalette::operator!=(const QPalette &p) const
- Returns true (slowly) if this palette is different from \a p;
- otherwise returns false (usually quickly).
+ Returns \c true (slowly) if this palette is different from \a p;
+ otherwise returns \c false (usually quickly).
\note The current ColorGroup is not taken into account when
comparing palettes
@@ -805,8 +805,8 @@ void QPalette::detach()
*/
/*!
- Returns true (usually quickly) if this palette is equal to \a p;
- otherwise returns false (slowly).
+ Returns \c true (usually quickly) if this palette is equal to \a p;
+ otherwise returns \c false (slowly).
\note The current ColorGroup is not taken into account when
comparing palettes
@@ -829,8 +829,8 @@ bool QPalette::operator==(const QPalette &p) const
/*!
\fn bool QPalette::isEqual(ColorGroup cg1, ColorGroup cg2) const
- Returns true (usually quickly) if color group \a cg1 is equal to
- \a cg2; otherwise returns false.
+ Returns \c true (usually quickly) if color group \a cg1 is equal to
+ \a cg2; otherwise returns \c false.
*/
bool QPalette::isEqual(QPalette::ColorGroup group1, QPalette::ColorGroup group2) const
{
@@ -1010,9 +1010,9 @@ QDataStream &operator>>(QDataStream &s, QPalette &p)
#endif //QT_NO_DATASTREAM
/*!
- Returns true if this palette and \a p are copies of each other,
+ Returns \c true if this palette and \a p are copies of each other,
i.e. one of them was created as a copy of the other and neither
- was subsequently modified; otherwise returns false. This is much
+ was subsequently modified; otherwise returns \c false. This is much
stricter than equality.
\sa operator=(), operator==()
diff --git a/src/gui/kernel/qplatforminputcontext.cpp b/src/gui/kernel/qplatforminputcontext.cpp
index 1cddccaab6..656c0d0fba 100644
--- a/src/gui/kernel/qplatforminputcontext.cpp
+++ b/src/gui/kernel/qplatforminputcontext.cpp
@@ -165,7 +165,7 @@ void QPlatformInputContext::emitKeyboardRectChanged()
/*!
This function can be reimplemented to return true whenever input method is animating
- shown or hidden. Default implementation returns false.
+ shown or hidden. Default implementation returns \c false.
*/
bool QPlatformInputContext::isAnimating() const
{
@@ -197,7 +197,7 @@ void QPlatformInputContext::hideInputPanel()
}
/*!
- Returns input panel visibility status. Default implementation returns false.
+ Returns input panel visibility status. Default implementation returns \c false.
*/
bool QPlatformInputContext::isInputPanelVisible() const
{
@@ -244,7 +244,7 @@ void QPlatformInputContext::setFocusObject(QObject *object)
}
/*!
- Returns true if current focus object supports input method events.
+ Returns \c true if current focus object supports input method events.
*/
bool QPlatformInputContext::inputMethodAccepted() const
{
diff --git a/src/gui/kernel/qplatformintegration.cpp b/src/gui/kernel/qplatformintegration.cpp
index 22d6746ce0..49ac7836cb 100644
--- a/src/gui/kernel/qplatformintegration.cpp
+++ b/src/gui/kernel/qplatformintegration.cpp
@@ -221,14 +221,14 @@ QPlatformServices *QPlatformIntegration::services() const
libraries.
\value NonFullScreenWindows The platform supports top-level windows which do not
- fill the screen. The default implementation returns true. Returning false for
+ fill the screen. The default implementation returns \c true. Returning false for
this will cause all windows, including dialogs and popups, to be resized to fill the
screen.
\value WindowManagement The platform is based on a system that performs window
management. This includes the typical desktop platforms. Can be set to false on
platforms where no window management is available, meaning for example that windows
- are never repositioned by the window manager. The default implementation returns true.
+ are never repositioned by the window manager. The default implementation returns \c true.
*/
/*!
diff --git a/src/gui/kernel/qplatformscreenpageflipper.cpp b/src/gui/kernel/qplatformscreenpageflipper.cpp
index dacc041c99..8665adc463 100644
--- a/src/gui/kernel/qplatformscreenpageflipper.cpp
+++ b/src/gui/kernel/qplatformscreenpageflipper.cpp
@@ -110,7 +110,7 @@ QPlatformScreenPageFlipper::QPlatformScreenPageFlipper(QObject *parent)
Implemented in subclasses to display \a buffer directly on the screen. Returns \c true
if it is possible to display the buffer, and \c false if the buffer cannot be displayed.
- If this function returns true, the buffer must not be modified or destroyed before the
+ If this function returns \c true, the buffer must not be modified or destroyed before the
bufferReleased() signal is emitted. The signal bufferDisplayed() is emitted when the buffer
is displayed on the screen. The two signals may be emitted in either order.
diff --git a/src/gui/kernel/qplatformsharedgraphicscache.cpp b/src/gui/kernel/qplatformsharedgraphicscache.cpp
index e008dde868..23224008b9 100644
--- a/src/gui/kernel/qplatformsharedgraphicscache.cpp
+++ b/src/gui/kernel/qplatformsharedgraphicscache.cpp
@@ -243,7 +243,7 @@ QT_BEGIN_NAMESPACE
/*!
\fn bool QPlatformSharedGraphicsCache::requestBatchStarted() const
- Returns true if a request batch has previously been started using beginRequestBatch()
+ Returns \c true if a request batch has previously been started using beginRequestBatch()
and not yet stopped using endRequestBatch().
\sa beginRequestBatch(), endRequestBatch()
@@ -278,7 +278,7 @@ QT_BEGIN_NAMESPACE
/*!
\fn bool QPlatformSharedGraphicsCache::dereferenceBuffer(void *bufferId)
- Removed a previously registered reference to the buffer \a bufferId. Returns true if there
+ Removed a previously registered reference to the buffer \a bufferId. Returns \c true if there
are still more references to the buffer in question, or false if this was the last reference
(in which case the buffer may have been deleted in the cache.)
diff --git a/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp b/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp
index b47b657361..5d7ff7864d 100644
--- a/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp
+++ b/src/gui/kernel/qplatformsystemtrayicon_qpa.cpp
@@ -135,12 +135,12 @@ QPlatformSystemTrayIcon::~QPlatformSystemTrayIcon()
/*!
\fn bool QPlatformSystemTrayIcon::isSystemTrayAvailable() const
- Returns true if the system tray is available on the platform.
+ Returns \c true if the system tray is available on the platform.
*/
/*!
\fn bool QPlatformSystemTrayIcon::supportsMessages() const
- Returns true if the system tray supports messages on the platform.
+ Returns \c true if the system tray supports messages on the platform.
*/
/*!
diff --git a/src/gui/kernel/qplatformwindow.cpp b/src/gui/kernel/qplatformwindow.cpp
index 4c0d68e7c1..ac82d56241 100644
--- a/src/gui/kernel/qplatformwindow.cpp
+++ b/src/gui/kernel/qplatformwindow.cpp
@@ -167,7 +167,7 @@ bool QPlatformWindow::isExposed() const
}
/*!
- Returns true if the window should appear active from a style perspective.
+ Returns \c true if the window should appear active from a style perspective.
This function can make platform-specific isActive checks, such as checking
if the QWindow is embedded in an active native window.
@@ -178,7 +178,7 @@ bool QPlatformWindow::isActive() const
}
/*!
- Returns true if the window is a descendant of an embedded non-Qt window.
+ Returns \c true if the window is a descendant of an embedded non-Qt window.
Example of an embedded non-Qt window is the parent window of an in-process QAxServer.
If \a parentWindow is nonzero, only check if the window is embedded in the
diff --git a/src/gui/kernel/qscreen.cpp b/src/gui/kernel/qscreen.cpp
index 558eca6b1d..2573f76374 100644
--- a/src/gui/kernel/qscreen.cpp
+++ b/src/gui/kernel/qscreen.cpp
@@ -579,8 +579,8 @@ QRect QScreen::mapBetween(Qt::ScreenOrientation a, Qt::ScreenOrientation b, cons
}
/*!
- Convenience function that returns true if \a o is either portrait or inverted portrait;
- otherwise returns false.
+ Convenience function that returns \c true if \a o is either portrait or inverted portrait;
+ otherwise returns \c false.
Qt::PrimaryOrientation is interpreted as the screen's primaryOrientation().
*/
@@ -591,8 +591,8 @@ bool QScreen::isPortrait(Qt::ScreenOrientation o) const
}
/*!
- Convenience function that returns true if \a o is either landscape or inverted landscape;
- otherwise returns false.
+ Convenience function that returns \c true if \a o is either landscape or inverted landscape;
+ otherwise returns \c false.
Qt::PrimaryOrientation is interpreted as the screen's primaryOrientation().
*/
diff --git a/src/gui/kernel/qsessionmanager.cpp b/src/gui/kernel/qsessionmanager.cpp
index c46dd5f55a..b9ef35854c 100644
--- a/src/gui/kernel/qsessionmanager.cpp
+++ b/src/gui/kernel/qsessionmanager.cpp
@@ -181,7 +181,7 @@ QString QSessionManager::sessionKey() const
/*!
Asks the session manager for permission to interact with the user. Returns
- true if interaction is permitted; otherwise returns false.
+ true if interaction is permitted; otherwise returns \c false.
The rationale behind this mechanism is to make it possible to synchronize
user interaction during a shutdown. Advanced session managers may ask all
@@ -215,7 +215,7 @@ bool QSessionManager::allowsInteraction()
}
/*!
- Returns true if error interaction is permitted; otherwise returns false.
+ Returns \c true if error interaction is permitted; otherwise returns \c false.
This is similar to allowsInteraction(), but also enables the application to
tell the user about any errors that occur. Session managers may give error
@@ -386,8 +386,8 @@ void QSessionManager::setManagerProperty(const QString &name,
}
/*!
- Returns true if the session manager is currently performing a second
- session management phase; otherwise returns false.
+ Returns \c true if the session manager is currently performing a second
+ session management phase; otherwise returns \c false.
\sa requestPhase2()
*/
diff --git a/src/gui/kernel/qsurfaceformat.cpp b/src/gui/kernel/qsurfaceformat.cpp
index 9b8ed4a289..b2abed7812 100644
--- a/src/gui/kernel/qsurfaceformat.cpp
+++ b/src/gui/kernel/qsurfaceformat.cpp
@@ -254,7 +254,7 @@ QSurfaceFormat::~QSurfaceFormat()
/*!
\fn bool QSurfaceFormat::stereo() const
- Returns true if stereo buffering is enabled; otherwise returns
+ Returns \c true if stereo buffering is enabled; otherwise returns
false. Stereo buffering is disabled by default.
\sa setStereo()
@@ -325,7 +325,7 @@ void QSurfaceFormat::setOption(QSurfaceFormat::FormatOptions opt)
}
/*!
- Returns true if format option \a opt is set; otherwise returns false.
+ Returns \c true if format option \a opt is set; otherwise returns \c false.
\sa setOption()
*/
@@ -383,7 +383,7 @@ QSurfaceFormat::SwapBehavior QSurfaceFormat::swapBehavior() const
}
/*!
- Returns true if the alpha buffer size is greater than zero.
+ Returns \c true if the alpha buffer size is greater than zero.
This means that the surface might be used with per pixel
translucency effects.
@@ -607,7 +607,7 @@ void QSurfaceFormat::setVersion(int major, int minor)
}
/*!
- Returns true if all the options of the two QSurfaceFormat objects
+ Returns \c true if all the options of the two QSurfaceFormat objects
\a a and \a b are equal.
\relates QSurfaceFormat
@@ -629,8 +629,8 @@ bool operator==(const QSurfaceFormat& a, const QSurfaceFormat& b)
}
/*!
- Returns false if all the options of the two QSurfaceFormat objects
- \a a and \a b are equal; otherwise returns true.
+ Returns \c false if all the options of the two QSurfaceFormat objects
+ \a a and \a b are equal; otherwise returns \c true.
\relates QSurfaceFormat
*/
diff --git a/src/gui/kernel/qwindow.cpp b/src/gui/kernel/qwindow.cpp
index 12ea4df1c9..f2e60e0ff3 100644
--- a/src/gui/kernel/qwindow.cpp
+++ b/src/gui/kernel/qwindow.cpp
@@ -126,8 +126,8 @@ QT_BEGIN_NAMESPACE
to a window with type QSurface::RasterSurface, and QOpenGLContext for
rendering with OpenGL to a window with type QSurface::OpenGLSurface.
- The application can start rendering as soon as isExposed() returns true,
- and can keep rendering until it isExposed() returns false. To find out when
+ The application can start rendering as soon as isExposed() returns \c true,
+ and can keep rendering until it isExposed() returns \c false. To find out when
isExposed() changes, reimplement exposeEvent(). The window will always get
a resize event before the first expose event.
@@ -903,7 +903,7 @@ bool QWindow::isExposed() const
*/
/*!
- Returns true if the window should appear active from a style perspective.
+ Returns \c true if the window should appear active from a style perspective.
This is the case for the window that has input focus as well as windows
that are in the same parent / transient parent chain as the focus window.
@@ -1067,7 +1067,7 @@ QWindow *QWindow::transientParent() const
*/
/*!
- Returns true if the window is an ancestor of the given \a child. If \a mode
+ Returns \c true if the window is an ancestor of the given \a child. If \a mode
is IncludeTransients, then transient parents are also considered ancestors.
*/
bool QWindow::isAncestorOf(const QWindow *child, AncestorMode mode) const
@@ -1728,7 +1728,7 @@ void QWindow::showNormal()
Close the window.
This closes the window, effectively calling destroy(), and potentially
- quitting the application. Returns true on success, false if it has a parent
+ quitting the application. Returns \c true on success, false if it has a parent
window (in which case the top level window should be closed instead).
\sa destroy(), QGuiApplication::quitOnLastWindowClosed()