diff options
| author | Edward Welbourne <edward.welbourne@qt.io> | 2022-07-27 19:08:26 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2022-09-01 17:44:40 +0000 |
| commit | 88d06dd980814801e0851f4cb125dd6199b5da08 (patch) | |
| tree | d817628b615fdb0f6286c2b0179e4de8974963ba | |
| parent | 863e308e6b49e3ea263c518cd9491daabb41e1d4 (diff) | |
Fix two trivial defects in testlib docs
A fragment of inline code wasn't wrapped in \c{}.
Doing so made the quotes it was wrapped in redundant.
Documentation of of QSKIP's parameter claimed it does something it
should, but it's up to the client code using it to write a description
that lives up to that.
Change-Id: Ib355b9b85c9986f244ae01479134245f182c912c
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
(cherry picked from commit 6dd6bf3467040b3efceafa317de6e833ee5ec15e)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/testlib/doc/src/qttestlib-manual.qdoc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/testlib/doc/src/qttestlib-manual.qdoc b/src/testlib/doc/src/qttestlib-manual.qdoc index c99c947253..aeb069574f 100644 --- a/src/testlib/doc/src/qttestlib-manual.qdoc +++ b/src/testlib/doc/src/qttestlib-manual.qdoc @@ -938,7 +938,7 @@ \snippet tutorial5/benchmarking.cpp 2 - The "if (useLocaleCompare)" switch is placed outside the QBENCHMARK + The \c{if (useLocaleCompare)} switch is placed outside the QBENCHMARK macro to avoid measuring its overhead. Each benchmark test function can have one active QBENCHMARK macro. @@ -977,7 +977,7 @@ the execution of the test without adding a failure to the test log. It can be used to skip tests that are certain to fail. The text in the QSKIP \a description parameter is appended to the test log, - and explains why the test was not carried out. + and should explain why the test was not carried out. QSKIP can be used to skip testing when the implementation is not yet complete or not supported on a certain platform. When there are known |