diff options
Diffstat (limited to 'src/testlib/doc/src/qttest-index.qdoc')
| -rw-r--r-- | src/testlib/doc/src/qttest-index.qdoc | 83 |
1 files changed, 31 insertions, 52 deletions
diff --git a/src/testlib/doc/src/qttest-index.qdoc b/src/testlib/doc/src/qttest-index.qdoc index 882340753b..59ce61eb0d 100644 --- a/src/testlib/doc/src/qttest-index.qdoc +++ b/src/testlib/doc/src/qttest-index.qdoc @@ -1,52 +1,32 @@ -/**************************************************************************** -** -** Copyright (C) 2020 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page qttest-index.html \title Qt Test \brief Provides classes for unit testing Qt applications and libraries. - Qt Test provides classes for unit testing Qt applications and libraries. - All public methods are in the \l QTest namespace. In addition, the - \l QSignalSpy class provides easy introspection for Qt's signals and slots, - and the \l QAbstractItemModelTester allows for non-destructive testing - of item models. + The Qt Test module provides classes for unit testing Qt applications and + libraries. All public methods are in the \l QTest namespace. In addition, + the \l QSignalSpy class provides easy introspection for Qt's signals and + slots, 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. - \include module-use.qdocinc using qt module - \snippet snippets/CMakeLists.txt cmake_use + \section1 Using the Module - See also the \l[QtDoc]{Build with CMake} overview. + \include {module-use.qdocinc} {using the c++ api} - \include module-use.qdocinc building with qmake - \snippet snippets/snippets.pro qmake_use + \section2 Building with CMake + + \include {module-use.qdocinc} {building with cmake} {Test} + + \section2 Building with qmake + + \include {module-use.qdocinc} {building_with_qmake} {testlib} \section1 Articles and Guides @@ -56,8 +36,21 @@ \li \l{Qt Test Tutorial} \endlist + \section1 Reference + + \list + \li \l{Qt Test C++ Classes} + \endlist + + The \l {Qt Quick Test} module enables unit testing of Qt Quick applications. + + \list + \li \l{Qt Quick Test QML Types} + \li \l{Qt Quick Test C++ API} + \endlist + \section1 Module Evolution - \l{Porting to Qt 6 - Qt Test} lists important changes in the module API + \l{Changes to Qt Test} lists important changes in the module API and functionality that were done for the Qt 6 series of Qt. \section1 Licenses and Attributions @@ -69,21 +62,7 @@ See \l{Qt Licensing} for further details. Furthermore, Qt Test in Qt \QtVersion may contain third party - modules under following permissive licenses: + modules under the following permissive licenses: \generatelist{groupsbymodule attributions-qttestlib} - - \section1 Reference - - \list - \li \l{Qt Test C++ Classes} - \endlist - - The \l {Qt Quick Test} module enables unit testing Qt Quick applications. - - \list - \li \l{Qt Quick Test QML Types} - \li \l{Qt Quick Test C++ API} - \endlist - */ |