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/testlib | |
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/testlib')
-rw-r--r-- | src/testlib/qbenchmarkvalgrind.cpp | 6 | ||||
-rw-r--r-- | src/testlib/qsignalspy.qdoc | 4 | ||||
-rw-r--r-- | src/testlib/qtestcase.cpp | 12 |
3 files changed, 11 insertions, 11 deletions
diff --git a/src/testlib/qbenchmarkvalgrind.cpp b/src/testlib/qbenchmarkvalgrind.cpp index e267c06ec3..545de3bb65 100644 --- a/src/testlib/qbenchmarkvalgrind.cpp +++ b/src/testlib/qbenchmarkvalgrind.cpp @@ -53,7 +53,7 @@ QT_BEGIN_NAMESPACE -// Returns true iff a sufficiently recent valgrind is available. +// Returns \c true iff a sufficiently recent valgrind is available. bool QBenchmarkValgrindUtils::haveValgrind() { #ifdef NVALGRIND @@ -84,7 +84,7 @@ bool QBenchmarkValgrindUtils::haveValgrind() } // Reruns this program through callgrind. -// Returns true upon success, otherwise false. +// Returns \c true upon success, otherwise false. bool QBenchmarkValgrindUtils::rerunThroughCallgrind(const QStringList &origAppArgs, int &exitCode) { if (!QBenchmarkValgrindUtils::runCallgrindSubProcess(origAppArgs, exitCode)) { @@ -187,7 +187,7 @@ QString QBenchmarkValgrindUtils::outFileBase(qint64 pid) // Reruns this program through callgrind, storing callgrind result files in the // current directory. -// Returns true upon success, otherwise false. +// Returns \c true upon success, otherwise false. bool QBenchmarkValgrindUtils::runCallgrindSubProcess(const QStringList &origAppArgs, int &exitCode) { const QString execFile(origAppArgs.at(0)); diff --git a/src/testlib/qsignalspy.qdoc b/src/testlib/qsignalspy.qdoc index 77dcd99741..9559090e8f 100644 --- a/src/testlib/qsignalspy.qdoc +++ b/src/testlib/qsignalspy.qdoc @@ -74,7 +74,7 @@ /*! \fn QSignalSpy::isValid() const - Returns true if the signal spy listens to a valid signal, otherwise false. + Returns \c true if the signal spy listens to a valid signal, otherwise false. */ /*! \fn QSignalSpy::signal() const @@ -93,7 +93,7 @@ Starts an event loop that runs until the given signal is received. Optionally the event loop can return earlier on a \a timeout (in milliseconds). - Returns true if the signal was emitted at least once in \a timeout milliseconds, otherwise returns false. + Returns \c true if the signal was emitted at least once in \a timeout milliseconds, otherwise returns \c false. Example: \snippet code/doc_src_qsignalspy.cpp 5 diff --git a/src/testlib/qtestcase.cpp b/src/testlib/qtestcase.cpp index ff90ed1c0e..260ace642e 100644 --- a/src/testlib/qtestcase.cpp +++ b/src/testlib/qtestcase.cpp @@ -864,7 +864,7 @@ QT_BEGIN_NAMESPACE \since 5.0 Waits for \a timeout milliseconds or until the \a window is exposed. - Returns true if \c window is exposed within \a timeout milliseconds, otherwise returns false. + Returns \c true if \c window is exposed within \a timeout milliseconds, otherwise returns \c false. This is mainly useful for asynchronous systems like X11, where a window will be mapped to screen some time after being asked to show itself on the screen. @@ -877,7 +877,7 @@ QT_BEGIN_NAMESPACE Waits for \a timeout milliseconds or until the \a window is active. - Returns true if \c window is active within \a timeout milliseconds, otherwise returns false. + Returns \c true if \c window is active within \a timeout milliseconds, otherwise returns \c false. \sa QTest::qWaitForWindowExposed(), QWindow::isActive() */ @@ -886,7 +886,7 @@ QT_BEGIN_NAMESPACE \since 5.0 Waits for \a timeout milliseconds or until the \a widget's window is exposed. - Returns true if \c widget's window is exposed within \a timeout milliseconds, otherwise returns false. + Returns \c true if \c widget's window is exposed within \a timeout milliseconds, otherwise returns \c false. This is mainly useful for asynchronous systems like X11, where a window will be mapped to screen some time after being asked to show itself on the screen. @@ -899,7 +899,7 @@ QT_BEGIN_NAMESPACE Waits for \a timeout milliseconds or until the \a widget's window is active. - Returns true if \c widget's window is active within \a timeout milliseconds, otherwise returns false. + Returns \c true if \c widget's window is active within \a timeout milliseconds, otherwise returns \c false. \sa QTest::qWaitForWindowExposed(), QWidget::isActiveWindow() */ @@ -909,7 +909,7 @@ QT_BEGIN_NAMESPACE \deprecated Waits for \a timeout milliseconds or until the \a widget's window is exposed. - Returns true if \c widget's window is exposed within \a timeout milliseconds, otherwise returns false. + Returns \c true if \c widget's window is exposed within \a timeout milliseconds, otherwise returns \c false. This function does the same as qWaitForWindowExposed(). @@ -2550,7 +2550,7 @@ const char *QTest::currentDataTag() } /*! - Returns true if the current test function failed, otherwise false. + Returns \c true if the current test function failed, otherwise false. */ bool QTest::currentTestFailed() { |