summaryrefslogtreecommitdiff
path: root/src/scripttools/doc/src/qtscripttools-index.qdoc
blob: 339c8b8c58a37e1037e6e292e19117b95c718406 (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
/****************************************************************************
**
** Copyright (C) 2017 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 qtscripttools-index.html
    \title Qt Script Tools
    \brief Provides a debugger for applications that use Qt Script

    The Qt Script Tools module provides a debugger that can be embedded into Qt
    applications that use \l{Qt Script}. The debugger enables the application
    user to inspect the state of the script environment and control script
    execution.

    \section1 Configuring the Build Process

    To include the definitions of the module's classes, use the
    following directive:

    \snippet doc_src_qtscripttools.cpp 0

    To link against the module, add this line to your \l {qmake Manual}{qmake} \c .pro file:

    \snippet doc_src_qtscripttools.pro 1

    \section1 Related Information

    \section2 Guides
    \list
    \li \l {Qt Script Debugger Manual}
    \endlist
    \section2 Reference
    \list
    \li \l{Qt Script Tools C++ Classes}{C++ Classes}
    \endlist

*/