diff options
Diffstat (limited to 'src/testlib/doc')
-rw-r--r-- | src/testlib/doc/qttestlib.qdocconf | 10 | ||||
-rw-r--r-- | src/testlib/doc/snippets/code/src_corelib_kernel_qtestsupport_core.cpp | 63 | ||||
-rw-r--r-- | src/testlib/doc/src/qttest-index.qdoc | 15 |
3 files changed, 84 insertions, 4 deletions
diff --git a/src/testlib/doc/qttestlib.qdocconf b/src/testlib/doc/qttestlib.qdocconf index 1fdb136e78..5fdf6d9415 100644 --- a/src/testlib/doc/qttestlib.qdocconf +++ b/src/testlib/doc/qttestlib.qdocconf @@ -27,12 +27,20 @@ qhp.QtTestLib.subprojects.classes.sortPages = true tagfile = ../../../doc/qttestlib/qttestlib.tags -depends += qtcore qtdoc qtwidgets qtgui qmake qtquick +depends += qtcore qtdoc qtwidgets qtgui qmake qtqmltest headerdirs += .. +headers += ../../corelib/kernel/qtestsupport_core.h \ + ../../gui/kernel/qtestsupport_gui.h \ + ../../widgets/kernel/qtestsupport_widgets.h + sourcedirs += .. +sources += ../../corelib/kernel/qtestsupport_core.cpp \ + ../../gui/kernel/qtestsupport_gui.cpp \ + ../../widgets/kernel/qtestsupport_widgets.cpp + exampledirs += ../../../examples/qtestlib \ ../ \ snippets diff --git a/src/testlib/doc/snippets/code/src_corelib_kernel_qtestsupport_core.cpp b/src/testlib/doc/snippets/code/src_corelib_kernel_qtestsupport_core.cpp new file mode 100644 index 0000000000..e793cb1f55 --- /dev/null +++ b/src/testlib/doc/snippets/code/src_corelib_kernel_qtestsupport_core.cpp @@ -0,0 +1,63 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +//! [0] + MyObject obj; + obj.startup(); + QTest::qWaitFor([&]() { + return obj.isReady(); + }, 3000); +//! [0] + +//! [1] + int i = 0; + while (myNetworkServerNotResponding() && i++ < 50) + QTest::qWait(250); +//! [1] diff --git a/src/testlib/doc/src/qttest-index.qdoc b/src/testlib/doc/src/qttest-index.qdoc index 8c817b3653..23be46b431 100644 --- a/src/testlib/doc/src/qttest-index.qdoc +++ b/src/testlib/doc/src/qttest-index.qdoc @@ -35,6 +35,11 @@ and the \l QAbstractItemModelTester allows for non-destructive testing of item models. + \note There is no binary compatibility guarantee for the Qt Test module. + This means that an application that uses Qt Test is only guaranteed + to work with the Qt version it was developed against. However, source + compatibility is guaranteed. + \section1 Getting Started To enable Qt Test in a project, add this directive into the C++ files: @@ -70,11 +75,15 @@ \section1 Reference - These are links to the API reference materials. + \list + \li \l{Qt Test C++ Classes} + \endlist + + The \l {Qt Quick Test} module enables unit testing Qt Quick applications. \list - \li \l{Qt Test C++ Classes}{C++ Classes} - \li \l{Qt Quick Test QML Types}{QML Types} + \li \l{Qt Quick Test QML Types} + \li \l{Qt Quick Test C++ API} \endlist */ |