summaryrefslogtreecommitdiffstats
path: root/src/testlib/doc/src/qttest-index.qdoc
blob: f5b077e8e8d9db627da8c0305cfca66aa0878287 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/****************************************************************************
**
** Copyright (C) 2016 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$
**
****************************************************************************/
/*!
    \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.

    \section1 Getting Started

    To enable Qt Test in a project, add this directive into the C++ files:

    \snippet code/doc_src_qttest.cpp 0

    To link against Qt Test, add this line to the project file:

    \snippet code/doc_src_qttest.pro 1

    \section1 Articles and Guides

    \list
        \li \l{Qt Test Overview}
        \li \l{Qt Test Tutorial}
    \endlist

    \section1 Licenses and Attributions

    Qt Test is available under commercial licenses from \l{The Qt Company}.
    In addition, it is available under free software licenses. Since Qt 5.4,
    these free software licenses are
    \l{GNU Lesser General Public License, version 3}, or
    the \l{GNU General Public License, version 2}.
    See \l{Qt Licensing} for further details.

    Furthermore, Qt Test in Qt \QtVersion may contain third party
    modules under following permissive licenses:

    \generatelist{groupsbymodule attributions-qttestlib}

    \section1 Reference

    These are links to the API reference materials.

    \list
        \li \l{Qt Test C++ Classes}{C++ Classes}
        \li \l{Qt Quick Test QML Types}{QML Types}
    \endlist

*/