diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/kernel | |
parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/corelib/kernel')
22 files changed, 233 insertions, 233 deletions
diff --git a/src/corelib/kernel/qabstracteventdispatcher.cpp b/src/corelib/kernel/qabstracteventdispatcher.cpp index 6558893036..54524fa55b 100644 --- a/src/corelib/kernel/qabstracteventdispatcher.cpp +++ b/src/corelib/kernel/qabstracteventdispatcher.cpp @@ -179,8 +179,8 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread) \fn bool QAbstractEventDispatcher::processEvents(QEventLoop::ProcessEventsFlags flags) Processes pending events that match \a flags until there are no - more events to process. Returns true if an event was processed; - otherwise returns false. + more events to process. Returns \c true if an event was processed; + otherwise returns \c false. This function is especially useful if you have a long running operation and want to show its progress without allowing user @@ -211,7 +211,7 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread) /*! \fn bool QAbstractEventDispatcher::hasPendingEvents() - Returns true if there is an event waiting; otherwise returns + Returns \c true if there is an event waiting; otherwise returns false. */ @@ -271,7 +271,7 @@ int QAbstractEventDispatcher::registerTimer(int interval, Qt::TimerType timerTyp \fn bool QAbstractEventDispatcher::unregisterTimer(int timerId) Unregisters the timer with the given \a timerId. - Returns true if successful; otherwise returns false. + Returns \c true if successful; otherwise returns \c false. \sa registerTimer(), unregisterTimers() */ @@ -280,7 +280,7 @@ int QAbstractEventDispatcher::registerTimer(int interval, Qt::TimerType timerTyp \fn bool QAbstractEventDispatcher::unregisterTimers(QObject *object) Unregisters all the timers associated with the given \a object. - Returns true if all timers were successful removed; otherwise returns false. + Returns \c true if all timers were successful removed; otherwise returns \c false. \sa unregisterTimer(), registeredTimers() */ @@ -435,8 +435,8 @@ void QAbstractEventDispatcher::removeNativeEventFilter(QAbstractNativeEventFilte /*! Sends \a message through the event filters that were set by - installNativeEventFilter(). This function returns true as soon as an - event filter returns true, and false otherwise to indicate that + installNativeEventFilter(). 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. Subclasses of QAbstractEventDispatcher \e must call this function @@ -474,8 +474,8 @@ bool QAbstractEventDispatcher::filterNativeEvent(const QByteArray &eventType, vo \deprecated Calls filterNativeEvent() with an empty eventType and \a message. - This function returns true as soon as an - event filter returns true, and false otherwise to indicate that + 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. */ diff --git a/src/corelib/kernel/qbasictimer.cpp b/src/corelib/kernel/qbasictimer.cpp index 2992812dcf..f3366489d5 100644 --- a/src/corelib/kernel/qbasictimer.cpp +++ b/src/corelib/kernel/qbasictimer.cpp @@ -62,7 +62,7 @@ QT_BEGIN_NAMESPACE function with a timeout interval and with a pointer to a QObject subclass. When the timer times out it will send a timer event to the QObject subclass. The timer can be stopped at any time using - stop(). isActive() returns true for a timer that is running; + stop(). isActive() returns \c true for a timer that is running; i.e. it has been started, has not reached the timeout time, and has not been stopped. The timer's ID can be retrieved using timerId(). @@ -90,8 +90,8 @@ QT_BEGIN_NAMESPACE /*! \fn bool QBasicTimer::isActive() const - Returns true if the timer is running and has not been stopped; otherwise - returns false. + Returns \c true if the timer is running and has not been stopped; otherwise + returns \c false. \sa start(), stop() */ diff --git a/src/corelib/kernel/qcoreapplication.cpp b/src/corelib/kernel/qcoreapplication.cpp index 115f7bc04e..0460c52d1c 100644 --- a/src/corelib/kernel/qcoreapplication.cpp +++ b/src/corelib/kernel/qcoreapplication.cpp @@ -810,8 +810,8 @@ void QCoreApplication::setAttribute(Qt::ApplicationAttribute attribute, bool on) } /*! - Returns true if attribute \a attribute is set; - otherwise returns false. + Returns \c true if attribute \a attribute is set; + otherwise returns \c false. \sa setAttribute() */ @@ -826,15 +826,15 @@ bool QCoreApplication::testAttribute(Qt::ApplicationAttribute attribute) /*! \property QCoreApplication::quitLockEnabled - Returns true if the use of the QEventLoopLocker feature can cause the - application to quit, otherwise returns false. + Returns \c true if the use of the QEventLoopLocker feature can cause the + application to quit, otherwise returns \c false. \sa QEventLoopLocker */ /*! - Returns true if the use of the QEventLoopLocker feature can cause the - application to quit, otherwise returns false. + Returns \c true if the use of the QEventLoopLocker feature can cause the + application to quit, otherwise returns \c false. \sa QEventLoopLocker */ @@ -892,7 +892,7 @@ bool QCoreApplication::notifyInternal(QObject *receiver, QEvent *event) For certain types of events (e.g. mouse and key events), the event will be propagated to the receiver's parent and so on up to the top-level object if the receiver is not interested in the event - (i.e., it returns false). + (i.e., it returns \c false). There are five different ways that events can be processed; reimplementing this virtual function is just one of them. All five @@ -1000,8 +1000,8 @@ bool QCoreApplicationPrivate::notify_helper(QObject *receiver, QEvent * event) } /*! - Returns true if an application object has not been created yet; - otherwise returns false. + Returns \c true if an application object has not been created yet; + otherwise returns \c false. \sa closingDown() */ @@ -1012,8 +1012,8 @@ bool QCoreApplication::startingUp() } /*! - Returns true if the application objects are being destroyed; - otherwise returns false. + Returns \c true if the application objects are being destroyed; + otherwise returns \c false. \sa startingUp() */ @@ -1283,7 +1283,7 @@ void QCoreApplication::postEvent(QObject *receiver, QEvent *event, int priority) /*! \internal - Returns true if \a event was compressed away (possibly deleted) and should not be added to the list. + Returns \c true if \a event was compressed away (possibly deleted) and should not be added to the list. */ bool QCoreApplication::compressEvent(QEvent *event, QObject *receiver, QPostEventList *postedEvents) { @@ -1711,7 +1711,7 @@ void QCoreApplication::quit() generated by Qt Designer provide a \c retranslateUi() function that can be called. - The function returns true on success and false on failure. + The function returns \c true on success and false on failure. \sa removeTranslator(), translate(), QTranslator::load(), {Dynamic Translation} */ @@ -1744,7 +1744,7 @@ bool QCoreApplication::installTranslator(QTranslator *translationFile) translation files used by this application. (It does not delete the translation file from the file system.) - The function returns true on success and false on failure. + The function returns \c true on success and false on failure. \sa installTranslator(), translate(), QObject::tr() */ @@ -2478,8 +2478,8 @@ void QCoreApplication::removeNativeEventFilter(QAbstractNativeEventFilter *filte } /*! - This function returns true if there are pending events; otherwise - returns false. Pending events can be either from the window + This function returns \c true if there are pending events; otherwise + returns \c false. Pending events can be either from the window system or posted events using postEvent(). \sa QAbstractEventDispatcher::hasPendingEvents() diff --git a/src/corelib/kernel/qcoreevent.cpp b/src/corelib/kernel/qcoreevent.cpp index 09fe7c60ca..cce385352e 100644 --- a/src/corelib/kernel/qcoreevent.cpp +++ b/src/corelib/kernel/qcoreevent.cpp @@ -61,9 +61,9 @@ QT_BEGIN_NAMESPACE QEvents, and sends the translated events to \l{QObject}s. In general, events come from the underlying window system - (spontaneous() returns true), but it is also possible to manually + (spontaneous() returns \c true), but it is also possible to manually send events using QCoreApplication::sendEvent() and - QCoreApplication::postEvent() (spontaneous() returns false). + QCoreApplication::postEvent() (spontaneous() returns \c false). QObjects receive events by having their QObject::event() function called. The function can be reimplemented in subclasses to @@ -382,8 +382,8 @@ QEvent::~QEvent() /*! \fn bool QEvent::spontaneous() const - Returns true if the event originated outside the application (a - system event); otherwise returns false. + Returns \c true if the event originated outside the application (a + system event); otherwise returns \c false. The return value of this function is not defined for paint events. */ @@ -487,7 +487,7 @@ QTimerEvent::~QTimerEvent() added or removed. In both cases you can only rely on the child being a QObject (or, - if QObject::isWidgetType() returns true, a QWidget). This is + if QObject::isWidgetType() returns \c true, a QWidget). This is because in the QEvent::ChildAdded case the child is not yet fully constructed; in the QEvent::ChildRemoved case it might have already been destructed. @@ -524,21 +524,21 @@ QChildEvent::~QChildEvent() /*! \fn bool QChildEvent::added() const - Returns true if type() is QEvent::ChildAdded; otherwise returns + Returns \c true if type() is QEvent::ChildAdded; otherwise returns false. */ /*! \fn bool QChildEvent::removed() const - Returns true if type() is QEvent::ChildRemoved; otherwise returns + Returns \c true if type() is QEvent::ChildRemoved; otherwise returns false. */ /*! \fn bool QChildEvent::polished() const - Returns true if type() is QEvent::ChildPolished; otherwise returns + Returns \c true if type() is QEvent::ChildPolished; otherwise returns false. */ diff --git a/src/corelib/kernel/qeventloop.cpp b/src/corelib/kernel/qeventloop.cpp index 3cb6890821..a93d6e4a21 100644 --- a/src/corelib/kernel/qeventloop.cpp +++ b/src/corelib/kernel/qeventloop.cpp @@ -117,8 +117,8 @@ QEventLoop::~QEventLoop() /*! Processes pending events that match \a flags until there are no - more events to process. Returns true if pending events were handled; - otherwise returns false. + more events to process. Returns \c true if pending events were handled; + otherwise returns \c false. This function is especially useful if you have a long running operation and want to show its progress without allowing user @@ -272,7 +272,7 @@ void QEventLoop::exit(int returnCode) } /*! - Returns true if the event loop is running; otherwise returns + Returns \c true if the event loop is running; otherwise returns false. The event loop is considered running from the time when exec() is called until exit() is called. diff --git a/src/corelib/kernel/qmetaobject.cpp b/src/corelib/kernel/qmetaobject.cpp index 8d6cf5beb5..ff2675dfc8 100644 --- a/src/corelib/kernel/qmetaobject.cpp +++ b/src/corelib/kernel/qmetaobject.cpp @@ -548,9 +548,9 @@ int QMetaObject::classInfoCount() const return n; } -// Returns true if the method defined by the given meta-object&handle +// Returns \c true if the method defined by the given meta-object&handle // matches the given name, argument count and argument types, otherwise -// returns false. +// returns \c false. static bool methodMatch(const QMetaObject *m, int handle, const QByteArray &name, int argc, const QArgumentType *types) @@ -886,8 +886,8 @@ QMetaMethod QMetaObjectPrivate::signal(const QMetaObject *m, int signal_index) /*! \internal - Returns true if the \a signalTypes and \a methodTypes are - compatible; otherwise returns false. + Returns \c true if the \a signalTypes and \a methodTypes are + compatible; otherwise returns \c false. */ bool QMetaObjectPrivate::checkConnectArgs(int signalArgc, const QArgumentType *signalTypes, int methodArgc, const QArgumentType *methodTypes) @@ -904,8 +904,8 @@ bool QMetaObjectPrivate::checkConnectArgs(int signalArgc, const QArgumentType *s /*! \internal - Returns true if the \a signal and \a method arguments are - compatible; otherwise returns false. + Returns \c true if the \a signal and \a method arguments are + compatible; otherwise returns \c false. */ bool QMetaObjectPrivate::checkConnectArgs(const QMetaMethodPrivate *signal, const QMetaMethodPrivate *method) @@ -1191,8 +1191,8 @@ QMetaClassInfo QMetaObject::classInfo(int index) const } /*! - Returns true if the \a signal and \a method arguments are - compatible; otherwise returns false. + Returns \c true if the \a signal and \a method arguments are + compatible; otherwise returns \c false. Both \a signal and \a method are expected to be normalized. @@ -1217,8 +1217,8 @@ bool QMetaObject::checkConnectArgs(const char *signal, const char *method) \since 5.0 \overload - Returns true if the \a signal and \a method arguments are - compatible; otherwise returns false. + Returns \c true if the \a signal and \a method arguments are + compatible; otherwise returns \c false. */ bool QMetaObject::checkConnectArgs(const QMetaMethod &signal, const QMetaMethod &method) @@ -1340,7 +1340,7 @@ enum { MaximumParamCount = 11 }; // up to 10 arguments + 1 return value /*! Invokes the \a member (a signal or a slot name) on the object \a - obj. Returns true if the member could be invoked. Returns false + obj. Returns \c true if the member could be invoked. Returns \c false if there is no such member or the parameters did not match. The invocation can be either synchronous or asynchronous, @@ -1549,8 +1549,8 @@ bool QMetaObject::invokeMethod(QObject *obj, \fn bool QMetaMethod::isValid() const \since 5.0 - Returns true if this method is valid (can be introspected and - invoked), otherwise returns false. + Returns \c true if this method is valid (can be introspected and + invoked), otherwise returns \c false. */ /*! \fn bool operator==(const QMetaMethod &m1, const QMetaMethod &m2) @@ -1558,8 +1558,8 @@ bool QMetaObject::invokeMethod(QObject *obj, \relates QMetaMethod \overload - Returns true if method \a m1 is equal to method \a m2, - otherwise returns false. + Returns \c true if method \a m1 is equal to method \a m2, + otherwise returns \c false. */ /*! \fn bool operator!=(const QMetaMethod &m1, const QMetaMethod &m2) @@ -1567,8 +1567,8 @@ bool QMetaObject::invokeMethod(QObject *obj, \relates QMetaMethod \overload - Returns true if method \a m1 is not equal to method \a m2, - otherwise returns false. + Returns \c true if method \a m1 is not equal to method \a m2, + otherwise returns \c false. */ /*! @@ -2007,8 +2007,8 @@ QMetaMethod QMetaMethod::fromSignalImpl(const QMetaObject *metaObject, void **si } /*! - Invokes this method on the object \a object. Returns true if the member could be invoked. - Returns false if there is no such member or the parameters did not match. + Invokes this method on the object \a object. Returns \c true if the member could be invoked. + Returns \c false if there is no such member or the parameters did not match. The invocation can be either synchronous or asynchronous, depending on the \a connectionType: @@ -2308,7 +2308,7 @@ bool QMetaMethod::invoke(QObject *object, /*! \fn bool QMetaEnum::isValid() const - Returns true if this enum is valid (has a name); otherwise returns + Returns \c true if this enum is valid (has a name); otherwise returns false. \sa name() @@ -2388,7 +2388,7 @@ int QMetaEnum::value(int index) const /*! - Returns true if this enumerator is used as a flag; otherwise returns + Returns \c true if this enumerator is used as a flag; otherwise returns false. When used as flags, enumerators can be combined using the OR @@ -2575,7 +2575,7 @@ static QByteArray qualifiedName(const QMetaEnum &e) attributes that specify its behavior: isReadable(), isWritable(), isDesignable(), isScriptable(), revision(), and isStored(). - If the property is an enumeration, isEnumType() returns true; if the + If the property is an enumeration, isEnumType() returns \c true; if the property is an enumeration that is also a flag (i.e. its values can be combined using the OR operator), isEnumType() and isFlagType() both return true. The enumerator for these types is @@ -2597,8 +2597,8 @@ static QByteArray qualifiedName(const QMetaEnum &e) /*! \fn bool QMetaProperty::isValid() const - Returns true if this property is valid (readable); otherwise - returns false. + Returns \c true if this property is valid (readable); otherwise + returns \c false. \sa isReadable() */ @@ -2722,8 +2722,8 @@ int QMetaProperty::propertyIndex() const } /*! - Returns true if the property's type is an enumeration value that - is used as a flag; otherwise returns false. + Returns \c true if the property's type is an enumeration value that + is used as a flag; otherwise returns \c false. Flags can be combined using the OR operator. A flag type is implicitly also an enum type. @@ -2737,8 +2737,8 @@ bool QMetaProperty::isFlagType() const } /*! - Returns true if the property's type is an enumeration value; - otherwise returns false. + Returns \c true if the property's type is an enumeration value; + otherwise returns \c false. \sa enumerator(), isFlagType() */ @@ -2754,7 +2754,7 @@ bool QMetaProperty::isEnumType() const /*! \internal - Returns true if the property has a C++ setter function that + Returns \c true if the property has a C++ setter function that follows Qt's standard "name" / "setName" pattern. Designer and uic query hasStdCppSet() in order to avoid expensive QObject::setProperty() calls. All properties in Qt [should] follow @@ -2853,7 +2853,7 @@ QVariant QMetaProperty::read(const QObject *object) const /*! Writes \a value as the property's value to the given \a object. Returns - true if the write succeeded; otherwise returns false. + true if the write succeeded; otherwise returns \c false. \sa read(), reset(), isWritable() */ @@ -2925,7 +2925,7 @@ bool QMetaProperty::write(QObject *object, const QVariant &value) const /*! Resets the property for the given \a object with a reset method. - Returns true if the reset worked; otherwise returns false. + Returns \c true if the reset worked; otherwise returns \c false. Reset methods are optional; only a few properties support them. @@ -2941,8 +2941,8 @@ bool QMetaProperty::reset(QObject *object) const } /*! - Returns true if this property can be reset to a default value; otherwise - returns false. + Returns \c true if this property can be reset to a default value; otherwise + returns \c false. \sa reset() */ @@ -2955,7 +2955,7 @@ bool QMetaProperty::isResettable() const } /*! - Returns true if this property is readable; otherwise returns false. + Returns \c true if this property is readable; otherwise returns \c false. \sa isWritable(), read(), isValid() */ @@ -2968,8 +2968,8 @@ bool QMetaProperty::isReadable() const } /*! - Returns true if this property has a corresponding change notify signal; - otherwise returns false. + Returns \c true if this property has a corresponding change notify signal; + otherwise returns \c false. \sa notifySignal() */ @@ -3048,7 +3048,7 @@ int QMetaProperty::revision() const } /*! - Returns true if this property is writable; otherwise returns + Returns \c true if this property is writable; otherwise returns false. \sa isReadable(), write() @@ -3063,12 +3063,12 @@ bool QMetaProperty::isWritable() const /*! - Returns true if this property is designable for the given \a object; - otherwise returns false. + Returns \c true if this property is designable for the given \a object; + otherwise returns \c false. - If no \a object is given, the function returns false if the + If no \a object is given, the function returns \c false if the \c{Q_PROPERTY()}'s \c DESIGNABLE attribute is false; otherwise - returns true (if the attribute is true or is a function or expression). + returns \c true (if the attribute is true or is a function or expression). \sa isScriptable(), isStored() */ @@ -3089,10 +3089,10 @@ bool QMetaProperty::isDesignable(const QObject *object) const } /*! - Returns true if the property is scriptable for the given \a object; - otherwise returns false. + Returns \c true if the property is scriptable for the given \a object; + otherwise returns \c false. - If no \a object is given, the function returns false if the + 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 (if the attribute is true or is a function or expression). @@ -3113,10 +3113,10 @@ bool QMetaProperty::isScriptable(const QObject *object) const } /*! - Returns true if the property is stored for \a object; otherwise returns + Returns \c true if the property is stored for \a object; otherwise returns false. - If no \a object is given, the function returns false if the + If no \a object is given, the function returns \c false if the \c{Q_PROPERTY()}'s \c STORED attribute is false; otherwise returns true (if the attribute is true or is a function or expression). @@ -3137,13 +3137,13 @@ bool QMetaProperty::isStored(const QObject *object) const } /*! - Returns true if this property is designated as the \c USER + Returns \c true if this property is designated as the \c USER property, i.e., the one that the user can edit for \a object 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 null, the function returns false if the \c + If \a object is null, the function returns \c false if the \c {Q_PROPERTY()}'s \c USER attribute is false. Otherwise it returns true. @@ -3165,7 +3165,7 @@ bool QMetaProperty::isUser(const QObject *object) const /*! \since 4.6 - Returns true if the property is constant; otherwise returns false. + Returns \c true if the property is constant; otherwise returns \c false. A property is constant if the \c{Q_PROPERTY()}'s \c CONSTANT attribute is set. @@ -3180,7 +3180,7 @@ bool QMetaProperty::isConstant() const /*! \since 4.6 - Returns true if the property is final; otherwise returns false. + Returns \c true if the property is final; otherwise returns \c false. A property is final if the \c{Q_PROPERTY()}'s \c FINAL attribute is set. @@ -3196,10 +3196,10 @@ bool QMetaProperty::isFinal() const /*! \obsolete - Returns true if the property is editable for the given \a object; - otherwise returns false. + Returns \c true if the property is editable for the given \a object; + otherwise returns \c false. - If no \a object is given, the function returns false if the + If no \a object is given, the function returns \c false if the \c{Q_PROPERTY()}'s \c EDITABLE attribute is false; otherwise returns true (if the attribute is true or is a function or expression). diff --git a/src/corelib/kernel/qmetaobjectbuilder.cpp b/src/corelib/kernel/qmetaobjectbuilder.cpp index ac57454169..4518d702cd 100644 --- a/src/corelib/kernel/qmetaobjectbuilder.cpp +++ b/src/corelib/kernel/qmetaobjectbuilder.cpp @@ -2144,7 +2144,7 @@ QByteArray QMetaPropertyBuilder::type() const } /*! - Returns true if this property has a notify signal; false otherwise. + Returns \c true if this property has a notify signal; false otherwise. \sa notifySignal(), setNotifySignal(), removeNotifySignal() */ @@ -2205,7 +2205,7 @@ void QMetaPropertyBuilder::removeNotifySignal() } /*! - Returns true if this property is readable; otherwise returns false. + Returns \c true if this property is readable; otherwise returns \c false. The default value is true. \sa setReadable(), isWritable() @@ -2220,7 +2220,7 @@ bool QMetaPropertyBuilder::isReadable() const } /*! - Returns true if this property is writable; otherwise returns false. + Returns \c true if this property is writable; otherwise returns \c false. The default value is true. \sa setWritable(), isReadable() @@ -2235,8 +2235,8 @@ bool QMetaPropertyBuilder::isWritable() const } /*! - Returns true if this property can be reset to a default value; otherwise - returns false. The default value is false. + Returns \c true if this property can be reset to a default value; otherwise + returns \c false. The default value is false. \sa setResettable() */ @@ -2250,7 +2250,7 @@ bool QMetaPropertyBuilder::isResettable() const } /*! - Returns true if this property is designable; otherwise returns false. + Returns \c true if this property is designable; otherwise returns \c false. This default value is false. \sa setDesignable(), isScriptable(), isStored() @@ -2265,7 +2265,7 @@ bool QMetaPropertyBuilder::isDesignable() const } /*! - Returns true if the property is scriptable; otherwise returns false. + Returns \c true if the property is scriptable; otherwise returns \c false. This default value is true. \sa setScriptable(), isDesignable(), isStored() @@ -2280,7 +2280,7 @@ bool QMetaPropertyBuilder::isScriptable() const } /*! - Returns true if the property is stored; otherwise returns false. + Returns \c true if the property is stored; otherwise returns \c false. This default value is false. \sa setStored(), isDesignable(), isScriptable() @@ -2295,7 +2295,7 @@ bool QMetaPropertyBuilder::isStored() const } /*! - Returns true if the property is editable; otherwise returns false. + Returns \c true if the property is editable; otherwise returns \c false. This default value is false. \sa setEditable(), isDesignable(), isScriptable(), isStored() @@ -2310,7 +2310,7 @@ bool QMetaPropertyBuilder::isEditable() const } /*! - Returns true if this property is designated as the \c USER + 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. This default value is false. @@ -2327,7 +2327,7 @@ bool QMetaPropertyBuilder::isUser() const } /*! - Returns true if the property has a C++ setter function that + Returns \c true if the property has a C++ setter function that follows Qt's standard "name" / "setName" pattern. Designer and uic query hasStdCppSet() in order to avoid expensive QObject::setProperty() calls. All properties in Qt [should] follow @@ -2345,8 +2345,8 @@ bool QMetaPropertyBuilder::hasStdCppSet() const } /*! - Returns true if the property is an enumerator or flag type; - otherwise returns false. This default value is false. + Returns \c true if the property is an enumerator or flag type; + otherwise returns \c false. This default value is false. \sa setEnumOrFlag() */ @@ -2360,7 +2360,7 @@ bool QMetaPropertyBuilder::isEnumOrFlag() const } /*! - Returns true if the property is constant; otherwise returns false. + Returns \c true if the property is constant; otherwise returns \c false. The default value is false. */ bool QMetaPropertyBuilder::isConstant() const @@ -2373,7 +2373,7 @@ bool QMetaPropertyBuilder::isConstant() const } /*! - Returns true if the property is final; otherwise returns false. + Returns \c true if the property is final; otherwise returns \c false. The default value is false. */ bool QMetaPropertyBuilder::isFinal() const @@ -2600,7 +2600,7 @@ QByteArray QMetaEnumBuilder::name() const } /*! - Returns true if this enumerator is used as a flag; otherwise returns + Returns \c true if this enumerator is used as a flag; otherwise returns false. \sa setIsFlag() diff --git a/src/corelib/kernel/qmetatype.cpp b/src/corelib/kernel/qmetatype.cpp index a9ba4aaaad..f74c592e8c 100644 --- a/src/corelib/kernel/qmetatype.cpp +++ b/src/corelib/kernel/qmetatype.cpp @@ -331,7 +331,7 @@ struct DefinedTypesFilter { \fn bool QMetaType::isValid() const \since 5.0 - Returns true if this QMetaType object contains valid + Returns \c true if this QMetaType object contains valid information about a type, false otherwise. */ @@ -339,7 +339,7 @@ struct DefinedTypesFilter { \fn bool QMetaType::isRegistered() const \since 5.0 - Returns true if this QMetaType object contains valid + Returns \c true if this QMetaType object contains valid information about a type, false otherwise. */ @@ -540,7 +540,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry) \fn bool QMetaType::registerConverter() \since 5.2 Registers the possibility of an implicit conversion from type From to type To in the meta - type system. Returns true if the registration succeeded, otherwise false. + type system. Returns \c true if the registration succeeded, otherwise false. */ /*! @@ -548,7 +548,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry) \since 5.2 \overload Registers a method \a function like To From::function() const as converter from type From - to type To in the meta type system. Returns true if the registration succeeded, otherwise false. + to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false. */ /*! @@ -556,7 +556,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry) \since 5.2 \overload Registers a method \a function like To From::function(bool *ok) const as converter from type From - to type To in the meta type system. Returns true if the registration succeeded, otherwise false. + to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false. */ /*! @@ -564,7 +564,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry) \since 5.2 \overload Registers a unary function object \a function as converter from type From - to type To in the meta type system. Returns true if the registration succeeded, otherwise false. + to type To in the meta type system. Returns \c true if the registration succeeded, otherwise false. */ /*! @@ -572,7 +572,7 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry) \since 5.2 Registers comparison operetarors for the user-registered type T. This requires T to have both an operator== and an operator<. - Returns true if the registration succeeded, otherwise false. + Returns \c true if the registration succeeded, otherwise false. */ #ifndef QT_NO_DEBUG_STREAM @@ -580,14 +580,14 @@ Q_GLOBAL_STATIC(QMetaTypeDebugStreamRegistry, customTypesDebugStreamRegistry) \fn bool QMetaType::registerDebugStreamOperator() Registers the debug stream operator for the user-registered type T. This requires T to have an operator<<(QDebug dbg, T). - Returns true if the registration succeeded, otherwise false. + Returns \c true if the registration succeeded, otherwise false. */ #endif /*! Registers function \a f as converter function from type id \a from to \a to. If there's already a conversion registered, this does nothing but deleting \a f. - Returns true if the registration succeeded, otherwise false. + Returns \c true if the registration succeeded, otherwise false. \since 5.2 \internal */ @@ -624,12 +624,12 @@ bool QMetaType::registerComparatorFunction(const QtPrivate::AbstractComparatorFu /*! \fn bool QMetaType::hasRegisteredComparators() - Returns true, if the meta type system has registered comparators for type T. + Returns \c true, if the meta type system has registered comparators for type T. \since 5.2 */ /*! - Returns true, if the meta type system has registered comparators for type id \a typeId. + Returns \c true, if the meta type system has registered comparators for type id \a typeId. \since 5.2 */ bool QMetaType::hasRegisteredComparators(int typeId) @@ -650,12 +650,12 @@ bool QMetaType::registerDebugStreamOperatorFunction(const QtPrivate::AbstractDeb /*! \fn bool QMetaType::hasRegisteredDebugStreamOperator() - Returns true, if the meta type system has a registered debug stream operator for type T. + Returns \c true, if the meta type system has a registered debug stream operator for type T. \since 5.2 */ /*! - Returns true, if the meta type system has a registered debug stream operator for type + Returns \c true, if the meta type system has a registered debug stream operator for type id \a typeId. \since 5.2 */ @@ -667,7 +667,7 @@ bool QMetaType::hasRegisteredDebugStreamOperator(int typeId) /*! Converts the object at \a from from \a fromTypeId to the preallocated space at \a to - typed \a toTypeId. Returns true, if the conversion succeeded, otherwise false. + typed \a toTypeId. Returns \c true, if the conversion succeeded, otherwise false. \since 5.2 */ bool QMetaType::convert(const void *from, int fromTypeId, void *to, int toTypeId) @@ -680,7 +680,7 @@ bool QMetaType::convert(const void *from, int fromTypeId, void *to, int toTypeId /*! Compares the objects at \a lhs and \a rhs. Both objects need to be of type \a typeId. \a result is set to less than, equal to or greater than zero, if \a lhs is less than, equal to - or greater than \a rhs. Returns true, if the comparison succeeded, otherwiess false. + or greater than \a rhs. Returns \c true, if the comparison succeeded, otherwiess false. \since 5.2 */ bool QMetaType::compare(const void *lhs, const void *rhs, int typeId, int* result) @@ -697,7 +697,7 @@ bool QMetaType::compare(const void *lhs, const void *rhs, int typeId, int* resul } /*! - Streams the object at \a rhs of type \a typeId to the debug stream \a dbg. Returns true + Streams the object at \a rhs of type \a typeId to the debug stream \a dbg. Returns \c true on success, otherwise false. \since 5.2 */ @@ -712,13 +712,13 @@ bool QMetaType::debugStream(QDebug& dbg, const void *rhs, int typeId) /*! \fn bool QMetaType::hasRegisteredConverterFunction() - Returns true, if the meta type system has a registered conversion from type From to type To. + Returns \c true, if the meta type system has a registered conversion from type From to type To. \since 5.2 \overload */ /*! - Returns true, if the meta type system has a registered conversion from meta type id \a fromTypeId + Returns \c true, if the meta type system has a registered conversion from meta type id \a fromTypeId to \a toTypeId \since 5.2 */ @@ -1027,8 +1027,8 @@ int QMetaType::registerNormalizedTypedef(const NS(QByteArray) &normalizedTypeNam } /*! - Returns true if the datatype with ID \a type is registered; - otherwise returns false. + Returns \c true if the datatype with ID \a type is registered; + otherwise returns \c false. \sa type(), typeName(), Type */ @@ -1103,8 +1103,8 @@ int qMetaTypeTypeInternal(const char *typeName) #ifndef QT_NO_DATASTREAM /*! Writes the object pointed to by \a data with the ID \a type to - the given \a stream. Returns true if the object is saved - successfully; otherwise returns false. + the given \a stream. Returns \c true if the object is saved + successfully; otherwise returns \c false. The type must have been registered with qRegisterMetaType() and qRegisterMetaTypeStreamOperators() beforehand. @@ -1320,8 +1320,8 @@ bool QMetaType::save(QDataStream &stream, int type, const void *data) /*! Reads the object of the specified \a type from the given \a - stream into \a data. Returns true if the object is loaded - successfully; otherwise returns false. + stream into \a data. Returns \c true if the object is loaded + successfully; otherwise returns \c false. The type must have been registered with qRegisterMetaType() and qRegisterMetaTypeStreamOperators() beforehand. diff --git a/src/corelib/kernel/qmimedata.cpp b/src/corelib/kernel/qmimedata.cpp index 6e571d2969..483692cdf8 100644 --- a/src/corelib/kernel/qmimedata.cpp +++ b/src/corelib/kernel/qmimedata.cpp @@ -363,8 +363,8 @@ void QMimeData::setUrls(const QList<QUrl> &urls) } /*! - Returns true if the object can return a list of urls; otherwise - returns false. + Returns \c true if the object can return a list of urls; otherwise + returns \c false. URLs correspond to the MIME type \c text/uri-list. @@ -402,8 +402,8 @@ void QMimeData::setText(const QString &text) } /*! - Returns true if the object can return plain text (MIME type \c - text/plain); otherwise returns false. + Returns \c true if the object can return plain text (MIME type \c + text/plain); otherwise returns \c false. \sa setText(), text(), hasHtml(), hasFormat() */ @@ -438,8 +438,8 @@ void QMimeData::setHtml(const QString &html) } /*! - Returns true if the object can return HTML (MIME type \c - text/html); otherwise returns false. + Returns \c true if the object can return HTML (MIME type \c + text/html); otherwise returns \c false. \sa setHtml(), html(), hasFormat() */ @@ -484,7 +484,7 @@ void QMimeData::setImageData(const QVariant &image) } /*! - Returns true if the object can return an image; otherwise returns + Returns \c true if the object can return an image; otherwise returns false. \sa setImageData(), imageData(), hasFormat() @@ -528,8 +528,8 @@ void QMimeData::setColorData(const QVariant &color) /*! - Returns true if the object can return a color (MIME type \c - application/x-color); otherwise returns false. + Returns \c true if the object can return a color (MIME type \c + application/x-color); otherwise returns \c false. \sa setColorData(), colorData(), hasFormat() */ @@ -572,8 +572,8 @@ void QMimeData::setData(const QString &mimeType, const QByteArray &data) } /*! - Returns true if the object can return data for the MIME type - specified by \a mimeType; otherwise returns false. + Returns \c true if the object can return data for the MIME type + specified by \a mimeType; otherwise returns \c false. For the most common types of data, you can call the higher-level functions hasText(), hasHtml(), hasUrls(), hasImage(), and diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index 3e9129a1eb..a52fd25e08 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -1005,9 +1005,9 @@ QObjectPrivate::Connection::~Connection() /*! \fn bool QObject::inherits(const char *className) const - Returns true if this object is an instance of a class that + Returns \c true if this object is an instance of a class that inherits \a className or a QObject subclass that inherits \a - className; otherwise returns false. + className; otherwise returns \c false. A class is considered to inherit itself. @@ -1068,7 +1068,7 @@ void QObject::setObjectName(const QString &name) /*! \fn bool QObject::isWidgetType() const - Returns true if the object is a widget; otherwise returns false. + Returns \c true if the object is a widget; otherwise returns \c false. Calling this function is equivalent to calling \c{inherits("QWidget")}, except that it is much faster. @@ -1077,7 +1077,7 @@ void QObject::setObjectName(const QString &name) /*! \fn bool QObject::isWindowType() const - Returns true if the object is a window; otherwise returns false. + Returns \c true if the object is a window; otherwise returns \c false. Calling this function is equivalent to calling \c{inherits("QWindow")}, except that it is much faster. @@ -1172,7 +1172,7 @@ void QObject::timerEvent(QTimerEvent *) QEvent::ChildAdded and QEvent::ChildRemoved events are sent to objects when children are added or removed. In both cases you can only rely on the child being a QObject, or if isWidgetType() - returns true, a QWidget. (This is because, in the + returns \c true, a QWidget. (This is because, in the \l{QEvent::ChildAdded}{ChildAdded} case, the child is not yet fully constructed, and in the \l{QEvent::ChildRemoved}{ChildRemoved} case it might have been destructed already). @@ -1249,7 +1249,7 @@ bool QObject::eventFilter(QObject * /* watched */, QEvent * /* event */) /*! \fn bool QObject::signalsBlocked() const - Returns true if signals are blocked; otherwise returns false. + Returns \c true if signals are blocked; otherwise returns \c false. Signals are not blocked by default. @@ -2279,8 +2279,8 @@ int QObject::receivers(const char *signal) const /*! \since 5.0 - Returns true if the \a signal is connected to at least one receiver, - otherwise returns false. + Returns \c true if the \a signal is connected to at least one receiver, + otherwise returns \c false. \a signal must be a signal member of this object, otherwise the behaviour is undefined. @@ -2682,8 +2682,8 @@ QMetaObject::Connection QObject::connect(const QObject *sender, const QMetaMetho \threadsafe Disconnects \a signal in object \a sender from \a method in object - \a receiver. Returns true if the connection is successfully broken; - otherwise returns false. + \a receiver. Returns \c true if the connection is successfully broken; + otherwise returns \c false. A signal-slot connection is removed when either of the objects involved are destroyed. @@ -2848,8 +2848,8 @@ bool QObject::disconnect(const QObject *sender, const char *signal, \since 4.8 Disconnects \a signal in object \a sender from \a method in object - \a receiver. Returns true if the connection is successfully broken; - otherwise returns false. + \a receiver. Returns \c true if the connection is successfully broken; + otherwise returns \c false. This function provides the same possibilities like disconnect(const QObject *sender, const char *signal, const QObject *receiver, const char *method) @@ -2998,7 +2998,7 @@ void QObject::connectNotify(const QMetaMethod &signal) If all signals were disconnected from this object (e.g., the signal argument to disconnect() was 0), disconnectNotify() is only called once, and the \a signal will be an invalid - QMetaMethod (QMetaMethod::isValid() returns false). + QMetaMethod (QMetaMethod::isValid() returns \c false). \warning This function violates the object-oriented principle of modularity. However, it might be useful for optimizing access to @@ -4506,8 +4506,8 @@ bool QObject::disconnect(const QMetaObject::Connection &connection) \threadsafe Disconnects \a signal in object \a sender from \a method in object - \a receiver. Returns true if the connection is successfully broken; - otherwise returns false. + \a receiver. Returns \c true if the connection is successfully broken; + otherwise returns \c false. A signal-slot connection is removed when either of the objects involved are destroyed. @@ -4657,7 +4657,7 @@ QMetaObject::Connection::~Connection() /*! \fn QMetaObject::Connection::operator bool() const - Returns true if the connection is valid. + Returns \c true if the connection is valid. The connection is valid if the call to QObject::connect succeeded. The connection is invalid if QObject::connect was not able to find diff --git a/src/corelib/kernel/qobject_p.h b/src/corelib/kernel/qobject_p.h index 562b0d24c7..f5745515c9 100644 --- a/src/corelib/kernel/qobject_p.h +++ b/src/corelib/kernel/qobject_p.h @@ -237,7 +237,7 @@ public: /*! \internal - Returns true if the signal with index \a signal_index from object \a sender is connected. + Returns \c true if the signal with index \a signal_index from object \a sender is connected. Signals with indices above a certain range are always considered connected (see connectedSignals in QObjectPrivate). If a signal spy is installed, all signals are considered connected. diff --git a/src/corelib/kernel/qobjectcleanuphandler.cpp b/src/corelib/kernel/qobjectcleanuphandler.cpp index 3a4fd3a648..6638fc5c86 100644 --- a/src/corelib/kernel/qobjectcleanuphandler.cpp +++ b/src/corelib/kernel/qobjectcleanuphandler.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE someone else it will automatically be removed from the cleanup handler. You can delete all the objects in the cleanup handler with clear(), or by destroying the cleanup handler. isEmpty() - returns true if the QObjectCleanupHandler has no objects to keep + returns \c true if the QObjectCleanupHandler has no objects to keep track of. \sa QPointer @@ -119,7 +119,7 @@ void QObjectCleanupHandler::remove(QObject *object) } /*! - Returns true if this cleanup handler is empty or if all objects in + Returns \c true if this cleanup handler is empty or if all objects in this cleanup handler have been destroyed; otherwise return false. \sa add(), remove(), clear() diff --git a/src/corelib/kernel/qpointer.cpp b/src/corelib/kernel/qpointer.cpp index 4fd6cd1779..692329f942 100644 --- a/src/corelib/kernel/qpointer.cpp +++ b/src/corelib/kernel/qpointer.cpp @@ -153,7 +153,7 @@ \fn bool QPointer::isNull() const Returns \c true if the referenced object has been destroyed or if - there is no referenced object; otherwise returns false. + there is no referenced object; otherwise returns \c false. */ /*! @@ -191,45 +191,45 @@ \fn bool operator==(const T *o, const QPointer<T> &p) \relates QPointer - Equality operator. Returns true if \a o and the guarded + Equality operator. Returns \c true if \a o and the guarded pointer \a p are pointing to the same object, otherwise - returns false. + returns \c false. */ /*! \fn bool operator==(const QPointer<T> &p, const T *o) \relates QPointer - Equality operator. Returns true if \a o and the guarded + Equality operator. Returns \c true if \a o and the guarded pointer \a p are pointing to the same object, otherwise - returns false. + returns \c false. */ /*! \fn bool operator==(T *o, const QPointer<T> &p) \relates QPointer - Equality operator. Returns true if \a o and the guarded + Equality operator. Returns \c true if \a o and the guarded pointer \a p are pointing to the same object, otherwise - returns false. + returns \c false. */ /*! \fn bool operator==(const QPointer<T> &p, T *o) \relates QPointer - Equality operator. Returns true if \a o and the guarded + Equality operator. Returns \c true if \a o and the guarded pointer \a p are pointing to the same object, otherwise - returns false. + returns \c false. */ /*! \fn bool operator==(const QPointer<T> &p1, const QPointer<T> &p2) \relates QPointer - Equality operator. Returns true if the guarded pointers \a p1 and \a p2 + Equality operator. Returns \c true if the guarded pointers \a p1 and \a p2 are pointing to the same object, otherwise - returns false. + returns \c false. */ @@ -238,41 +238,41 @@ \fn bool operator!=(const T *o, const QPointer<T> &p) \relates QPointer - Inequality operator. Returns true if \a o and the guarded + Inequality operator. Returns \c true if \a o and the guarded pointer \a p are not pointing to the same object, otherwise - returns false. + returns \c false. */ /*! \fn bool operator!=(const QPointer<T> &p, const T *o) \relates QPointer - Inequality operator. Returns true if \a o and the guarded + Inequality operator. Returns \c true if \a o and the guarded pointer \a p are not pointing to the same object, otherwise - returns false. + returns \c false. */ /*! \fn bool operator!=(T *o, const QPointer<T> &p) \relates QPointer - Inequality operator. Returns true if \a o and the guarded + Inequality operator. Returns \c true if \a o and the guarded pointer \a p are not pointing to the same object, otherwise - returns false. + returns \c false. */ /*! \fn bool operator!=(const QPointer<T> &p, T *o) \relates QPointer - Inequality operator. Returns true if \a o and the guarded + Inequality operator. Returns \c true if \a o and the guarded pointer \a p are not pointing to the same object, otherwise - returns false. + returns \c false. */ /*! \fn bool operator!=(const QPointer<T> &p1, const QPointer<T> &p2) \relates QPointer - Inequality operator. Returns true if the guarded pointers \a p1 and + Inequality operator. Returns \c true if the guarded pointers \a p1 and \a p2 are not pointing to the same object, otherwise - returns false. + returns \c false. */ /*! \fn QPointer<T> qPointerFromVariant(const QVariant &variant) diff --git a/src/corelib/kernel/qsharedmemory.cpp b/src/corelib/kernel/qsharedmemory.cpp index 51c402501d..1f53b94c4d 100644 --- a/src/corelib/kernel/qsharedmemory.cpp +++ b/src/corelib/kernel/qsharedmemory.cpp @@ -389,7 +389,7 @@ int QSharedMemory::size() const identified by the key that was passed to the constructor or to a call to setKey() or setNativeKey(). The access \a mode is \l {QSharedMemory::} {ReadWrite} by default. It can also be \l {QSharedMemory::} - {ReadOnly}. Returns true if the attach operation is successful. If + {ReadOnly}. Returns \c true if the attach operation is successful. If false is returned, call error() to determine which error occurred. After attaching the shared memory segment, a pointer to the shared memory can be obtained by calling data(). @@ -415,7 +415,7 @@ bool QSharedMemory::attach(AccessMode mode) } /*! - Returns true if this process is attached to the shared memory + Returns \c true if this process is attached to the shared memory segment. \sa attach(), detach() @@ -430,8 +430,8 @@ bool QSharedMemory::isAttached() const Detaches the process from the shared memory segment. If this was the last process attached to the shared memory segment, then the shared memory segment is released by the system, i.e., the contents are - destroyed. The function returns true if it detaches the shared - memory segment. If it returns false, it usually means the segment + destroyed. The function returns \c true if it detaches the shared + memory segment. If it returns \c false, it usually means the segment either isn't attached, or it is locked by another process. \sa attach(), isAttached() @@ -493,9 +493,9 @@ const void *QSharedMemory::data() const #ifndef QT_NO_SYSTEMSEMAPHORE /*! This is a semaphore that locks the shared memory segment for access - by this process and returns true. If another process has locked the + by this process and returns \c true. If another process has locked the segment, this function blocks until the lock is released. Then it - acquires the lock and returns true. If this function returns false, + acquires the lock and returns \c true. If this function returns \c false, it means that you have ignored a false return from create() or attach(), that you have set the key with setNativeKey() or that QSystemSemaphore::acquire() failed due to an unknown system error. @@ -520,7 +520,7 @@ bool QSharedMemory::lock() } /*! - Releases the lock on the shared memory segment and returns true, if + Releases the lock on the shared memory segment and returns \c true, if the lock is currently held by this process. If the segment is not locked, or if the lock is held by another process, nothing happens and false is returned. diff --git a/src/corelib/kernel/qsharedmemory_unix.cpp b/src/corelib/kernel/qsharedmemory_unix.cpp index fdd73657a9..24598538e5 100644 --- a/src/corelib/kernel/qsharedmemory_unix.cpp +++ b/src/corelib/kernel/qsharedmemory_unix.cpp @@ -143,7 +143,7 @@ key_t QSharedMemoryPrivate::handle() /*! \internal Creates the unix file if needed. - returns true if the unix file was created. + returns \c true if the unix file was created. -1 error 0 already existed diff --git a/src/corelib/kernel/qsocketnotifier.cpp b/src/corelib/kernel/qsocketnotifier.cpp index 6c88ed4531..6470873d9a 100644 --- a/src/corelib/kernel/qsocketnotifier.cpp +++ b/src/corelib/kernel/qsocketnotifier.cpp @@ -238,7 +238,7 @@ QSocketNotifier::Type QSocketNotifier::type() const } /*! - Returns true if the notifier is enabled; otherwise returns false. + Returns \c true if the notifier is enabled; otherwise returns \c false. \sa setEnabled() */ diff --git a/src/corelib/kernel/qsystemsemaphore.cpp b/src/corelib/kernel/qsystemsemaphore.cpp index 46269c5a24..6f0e5ee011 100644 --- a/src/corelib/kernel/qsystemsemaphore.cpp +++ b/src/corelib/kernel/qsystemsemaphore.cpp @@ -261,7 +261,7 @@ QString QSystemSemaphore::key() const /*! Acquires one of the resources guarded by this semaphore, if there is - one available, and returns true. If all the resources guarded by this + one available, and returns \c true. If all the resources guarded by this semaphore have already been acquired, the call blocks until one of them is released by another process or thread having a semaphore with the same key. @@ -278,7 +278,7 @@ bool QSystemSemaphore::acquire() } /*! - Releases \a n resources guarded by the semaphore. Returns true + Releases \a n resources guarded by the semaphore. Returns \c true unless there is a system error. Example: Create a system semaphore having five resources; acquire diff --git a/src/corelib/kernel/qtimer.cpp b/src/corelib/kernel/qtimer.cpp index 71d8d99a91..db6ff568bd 100644 --- a/src/corelib/kernel/qtimer.cpp +++ b/src/corelib/kernel/qtimer.cpp @@ -175,14 +175,14 @@ QTimer::~QTimer() \property QTimer::active \since 4.3 - This boolean property is true if the timer is running; otherwise + This boolean property is \c true if the timer is running; otherwise false. */ /*! \fn bool QTimer::isActive() const - Returns true if the timer is running (pending); otherwise returns + Returns \c true if the timer is running (pending); otherwise returns false. */ diff --git a/src/corelib/kernel/qtimerinfo_unix.cpp b/src/corelib/kernel/qtimerinfo_unix.cpp index f1bbbe5338..3d3c566a8b 100644 --- a/src/corelib/kernel/qtimerinfo_unix.cpp +++ b/src/corelib/kernel/qtimerinfo_unix.cpp @@ -108,7 +108,7 @@ timespec qAbsTimespec(const timespec &t) } /* - Returns true if the real time clock has changed by more than 10% + Returns \c true if the real time clock has changed by more than 10% relative to the processor time since the last time this function was called. This presumably means that the system time has been changed. diff --git a/src/corelib/kernel/qtranslator.cpp b/src/corelib/kernel/qtranslator.cpp index 903ab2e2cd..843a6edce1 100644 --- a/src/corelib/kernel/qtranslator.cpp +++ b/src/corelib/kernel/qtranslator.cpp @@ -431,8 +431,8 @@ QTranslator::~QTranslator() Loads \a filename + \a suffix (".qm" if the \a suffix is not specified), which may be an absolute file name or relative to \a - directory. Returns true if the translation is successfully loaded; - otherwise returns false. + directory. Returns \c true if the translation is successfully loaded; + otherwise returns \c false. If \a directory is not specified, the directory of the application's executable is used (i.e., as @@ -708,8 +708,8 @@ static QString find_translation(const QLocale & locale, Loads \a filename + \a prefix + \l{QLocale::uiLanguages()}{ui language name} + \a suffix (".qm" if the \a suffix is not specified), which may be - an absolute file name or relative to \a directory. Returns true if the - translation is successfully loaded; otherwise returns false. + an absolute file name or relative to \a directory. Returns \c true if the + translation is successfully loaded; otherwise returns \c false. The previous contents of this translator object are discarded. @@ -1104,7 +1104,7 @@ QString QTranslator::translate(const char *context, const char *sourceText, cons } /*! - Returns true if this translator is empty, otherwise returns false. + Returns \c true if this translator is empty, otherwise returns \c false. This function works with stripped and unstripped translation files. */ bool QTranslator::isEmpty() const diff --git a/src/corelib/kernel/qvariant.cpp b/src/corelib/kernel/qvariant.cpp index a7c0bd2321..20e13a050f 100644 --- a/src/corelib/kernel/qvariant.cpp +++ b/src/corelib/kernel/qvariant.cpp @@ -1988,8 +1988,8 @@ QDataStream& operator<<(QDataStream &s, const QVariant::Type p) /*! \fn bool QVariant::isValid() const - Returns true if the storage type of this variant is not - QVariant::Invalid; otherwise returns false. + Returns \c true if the storage type of this variant is not + QVariant::Invalid; otherwise returns \c false. */ template <typename T> @@ -2521,12 +2521,12 @@ qulonglong QVariant::toULongLong(bool *ok) const /*! Returns the variant as a bool if the variant has userType() Bool. - Returns true if the variant has userType() \l QMetaType::Bool, + Returns \c true if the variant has userType() \l QMetaType::Bool, \l QMetaType::QChar, \l QMetaType::Double, \l QMetaType::Int, \l QMetaType::LongLong, \l QMetaType::UInt, or \l QMetaType::ULongLong and the value is non-zero, or if the variant has type \l QMetaType::QString or \l QMetaType::QByteArray and its lower-case content is not one of the - following: empty, "0" or "false"; otherwise returns false. + following: empty, "0" or "false"; otherwise returns \c false. \sa canConvert(), convert() */ @@ -2694,7 +2694,7 @@ static const quint32 qCanConvertMatrix[QVariant::LastCoreType + 1] = #ifndef QT_BOOTSTRAPPED /*! - Returns true if from inherits to. + Returns \c true if from inherits to. */ static bool canConvertMetaObject(const QMetaObject *from, const QMetaObject *to) { @@ -2730,7 +2730,7 @@ static bool canConvertMetaObject(int fromId, int toId, QObject *fromObject) /*! - Returns true if the variant's type can be cast to the requested + Returns \c true if the variant's type can be cast to the requested type, \a targetTypeId. Such casting is done automatically when calling the toInt(), toBool(), ... methods. @@ -2933,8 +2933,8 @@ bool QVariant::canConvert(int targetTypeId) const /*! Casts the variant to the requested type, \a targetTypeId. If the cast cannot be - done, the variant is cleared. Returns true if the current type of - the variant was successfully cast; otherwise returns false. + done, the variant is cleared. Returns \c true if the current type of + the variant was successfully cast; otherwise returns \c false. A QVariant containing a pointer to a type derived from QObject will also convert and return true for this function if a qobject_cast to the type described @@ -2991,7 +2991,7 @@ bool QVariant::convert(const int type, void *ptr) const \relates QVariant - Returns true if \a v1 and \a v2 are equal; otherwise returns false. + Returns \c true if \a v1 and \a v2 are equal; otherwise returns \c false. If \a v1 and \a v2 have the same \l{QVariant::}{type()}, the type's equality operator is used for comparison. If not, it is @@ -3012,7 +3012,7 @@ bool QVariant::convert(const int type, void *ptr) const \relates QVariant - Returns false if \a v1 and \a v2 are equal; otherwise returns true. + Returns \c false if \a v1 and \a v2 are equal; otherwise returns \c true. \warning To make this function work with a custom type registered with qRegisterMetaType(), its comparison operator must be registered using @@ -3021,8 +3021,8 @@ bool QVariant::convert(const int type, void *ptr) const /*! \fn bool QVariant::operator==(const QVariant &v) const - Compares this QVariant with \a v and returns true if they are - equal; otherwise returns false. + Compares this QVariant with \a v and returns \c true if they are + equal; otherwise returns \c false. QVariant uses the equality operator of the type() it contains to check for equality. QVariant will try to convert() \a v if its @@ -3037,8 +3037,8 @@ bool QVariant::convert(const int type, void *ptr) const /*! \fn bool QVariant::operator!=(const QVariant &v) const - Compares this QVariant with \a v and returns true if they are not - equal; otherwise returns false. + Compares this QVariant with \a v and returns \c true if they are not + equal; otherwise returns \c false. \warning To make this function work with a custom type registered with qRegisterMetaType(), its comparison operator must be registered using @@ -3048,7 +3048,7 @@ bool QVariant::convert(const int type, void *ptr) const /*! \fn bool QVariant::operator<(const QVariant &v) const - Compares this QVariant with \a v and returns true if this is less than \a v. + Compares this QVariant with \a v and returns \c true if this is less than \a v. \note Comparability might not be availabe for the type stored in this QVariant or in \a v. @@ -3061,7 +3061,7 @@ bool QVariant::convert(const int type, void *ptr) const /*! \fn bool QVariant::operator<=(const QVariant &v) const - Compares this QVariant with \a v and returns true if this is less or equal than \a v. + Compares this QVariant with \a v and returns \c true if this is less or equal than \a v. \note Comparability might not be available for the type stored in this QVariant or in \a v. @@ -3074,7 +3074,7 @@ bool QVariant::convert(const int type, void *ptr) const /*! \fn bool QVariant::operator>(const QVariant &v) const - Compares this QVariant with \a v and returns true if this is larger than \a v. + Compares this QVariant with \a v and returns \c true if this is larger than \a v. \note Comparability might not be available for the type stored in this QVariant or in \a v. @@ -3087,7 +3087,7 @@ bool QVariant::convert(const int type, void *ptr) const /*! \fn bool QVariant::operator>=(const QVariant &v) const - Compares this QVariant with \a v and returns true if this is larger or equal than \a v. + Compares this QVariant with \a v and returns \c true if this is larger or equal than \a v. \note Comparability might not be available for the type stored in this QVariant or in \a v. @@ -3207,7 +3207,7 @@ void* QVariant::data() /*! - Returns true if this is a null variant, false otherwise. A variant is + Returns \c true if this is a null variant, false otherwise. A variant is considered null if it contains a default constructed value or a built-in type instance that has an isNull method, in which case the result would be the same as calling isNull on the wrapped object. @@ -3298,7 +3298,7 @@ QDebug operator<<(QDebug dbg, const QVariant::Type p) /*! \fn bool QVariant::canConvert() const - Returns true if the variant can be converted to the template type \c{T}, + Returns \c true if the variant can be converted to the template type \c{T}, otherwise false. Example: @@ -3396,8 +3396,8 @@ QDebug operator<<(QDebug dbg, const QVariant::Type p) \relates QVariant \obsolete - Returns true if the given \a value can be converted to the - template type specified; otherwise returns false. + Returns \c true if the given \a value can be converted to the + template type specified; otherwise returns \c false. This function is equivalent to QVariant::canConvert(\a value). @@ -3608,8 +3608,8 @@ const QVariant QSequentialIterable::const_iterator::operator*() const } /*! - Returns true if \a other points to the same item as this - iterator; otherwise returns false. + Returns \c true if \a other points to the same item as this + iterator; otherwise returns \c false. \sa operator!=() */ @@ -3619,8 +3619,8 @@ bool QSequentialIterable::const_iterator::operator==(const const_iterator &other } /*! - Returns true if \a other points to a different item than this - iterator; otherwise returns false. + Returns \c true if \a other points to a different item than this + iterator; otherwise returns \c false. \sa operator==() */ @@ -3942,8 +3942,8 @@ const QVariant QAssociativeIterable::const_iterator::value() const } /*! - Returns true if \a other points to the same item as this - iterator; otherwise returns false. + Returns \c true if \a other points to the same item as this + iterator; otherwise returns \c false. \sa operator!=() */ @@ -3953,8 +3953,8 @@ bool QAssociativeIterable::const_iterator::operator==(const const_iterator &othe } /*! - Returns true if \a other points to a different item than this - iterator; otherwise returns false. + Returns \c true if \a other points to a different item than this + iterator; otherwise returns \c false. \sa operator==() */ diff --git a/src/corelib/kernel/qwineventnotifier.cpp b/src/corelib/kernel/qwineventnotifier.cpp index 242702b304..eab5a37645 100644 --- a/src/corelib/kernel/qwineventnotifier.cpp +++ b/src/corelib/kernel/qwineventnotifier.cpp @@ -183,7 +183,7 @@ HANDLE QWinEventNotifier::handle() const } /*! - Returns true if the notifier is enabled; otherwise returns false. + Returns \c true if the notifier is enabled; otherwise returns \c false. \sa setEnabled() */ |