aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/reference.qdoc
blob: f1975bf3a1dec640da127fe5b72104a643356cec (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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $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$
**
****************************************************************************/
/*!
    \contentspage index.html
    \previouspage howtos.html
    \page reference.html
    \nextpage building-qbs.html

    \title Reference

    \list
        \li \l{List of All Items}
        \list
            \li \l{List of Language Items}
            \li \l{List of Convenience Items}
            \li \l{List of Probes}
        \endlist
        \li \l{List of Built-in Services}
        \li \l{Command-Line Interface}
        \li \l{List of Modules}
        \li \l{Command and JavaScriptCommand}
    \endlist
*/

/*!
    \contentspage reference.html
    \group list-of-builtin-services
    \title List of Built-in Services
    \QBS provides the following built-in JavaScript extensions to simplify operations that
    are expected to be needed often in project files.

    To gain access to the operations provided by a particular Service - for example,
    the File service - use the following statement at the top of your \QBS project file:
    \code
    import qbs.File
    \endcode

    If you instead need to access the service from a JavaScript file, import it using the following
    statement at the top of your JavaScript file:
    \code
    var File = require("qbs.File");
    \endcode
*/

/*!
    \contentspage reference.html
    \qmlmodule QbsModules
    \title List of Modules
    These are the modules shipped with \QBS.

    For a list of \QBS modules that provide support for Qt modules, see
    \l{Qt Modules}. Only the Qt modules that have properties and relevant file
    tags are described in separate topics.
*/

/*!
    \contentspage reference.html
    \group list-of-items
    \title List of All Items

    \QBS provides the following \l{List of Language Items}{built-in},
    \l{List of Convenience Items}{convenience}, and \l{List of Probes}{probe}
    items to define projects.
*/

/*!
    \contentspage reference.html
    \qmlmodule QbsLanguageItems
    \title List of Language Items

    \QBS provides the following built-in QML items to define projects.
    These are the primitives upon which all other \QBS items are built.
*/

/*!
    \contentspage reference.html
    \qmlmodule QbsConvenienceItems
    \title List of Convenience Items

    \QBS provides the following QML items for convenience.
*/

/*!
    \contentspage reference.html
    \group list-of-probes
    \title List of Probes

    These are the probes shipped with \QBS.

    Probes are used to retrieve information from the system prior to building. Typically, probes
    call external processes to get the required information. For details, see \l{Probe}{Probe} page.
*/