aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/modules/xcode-module.qdoc
blob: 748226c065ec52a55e708e67bee475601754817f (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Copyright (C) 2015 Jake Petroules.
** 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$
**
****************************************************************************/
/*!
    \qmltype xcode
    \inqmlmodule QbsModules
    \since Qbs 1.5

    \brief Provides Xcode support.

    The \c xcode module contains properties and rules for Xcode-based development.
    This module provides the foundation for several other modules on Apple
    platforms, including the \l{cpp} and \l{ib} modules.
*/

/*!
    \qmlproperty path xcode::developerPath

    The developer directory of the Xcode installation.

    Corresponds to the \c DEVELOPER_DIR environment variable.

    \defaultvalue The developer directory of the Xcode installation at its
    default location in \c /Applications. For example,
    \c{"/Applications/Xcode.app/Contents/Developer"}.

*/

/*!
    \qmlproperty string xcode::sdk

    The version of the Xcode SDK used to build products.

    This can be specified as a full canonical SDK name (\c{"macosx10.10"}), a
    platform version number (\c{"10.10"}), or a platform identifier
    (\c{"macosx"}), in which case the latest SDK available for that platform
    will be used.

    \defaultvalue The latest SDK available in the Xcode installation for the
    current platform. Determined by \l{qbs::targetOS}{qbs.targetOS}.
*/

/*!
    \qmlproperty stringList xcode::targetDevices

    A list of the Apple devices targeted by this product.

    For macOS, watchOS, and tvOS, this should always be \c "mac", \c "watch",
    and \c "tv", respectively. For iOS, this can be one or both of \c "iphone"
    and \c "ipad".

    \defaultvalue The list of all device types supported by the current
    platform. Determined by \l{qbs::targetOS}{qbs.targetOS}.
*/

/*!
    \qmlproperty string xcode::sdkName
    \readonly

    The canonical name of the SDK used to build products.

    For example, \c macosx10.9.

    \defaultvalue \l{xcode::}{sdk}
*/

/*!
    \qmlproperty string xcode::sdkVersion
    \readonly

    The version number of the SDK used to build products.

    For example, 10.9.

    \defaultvalue \l{xcode::}{sdk}
*/

/*!
    \qmlproperty string xcode::latestSdkName
    \readonly

    The canonical name of the latest SDK available in the Xcode installation.

    For example, \c {macosx10.10}.

    \defaultvalue \l{xcode::}{developerPath}
*/

/*!
    \qmlproperty string xcode::latestSdkVersion
    \readonly

    The version number of the latest SDK available in the Xcode installation.

    For example, 10.10.

    \defaultvalue \l{xcode::}{developerPath}
*/

/*!
    \qmlproperty stringList xcode::availableSdkNames
    \readonly

    The canonical names of all SDKs available in the Xcode installation for the
    current platform.

    For example, \c {[macosx10.9, macosx10.10]}.

    \defaultvalue \l{xcode::}{developerPath}
*/

/*!
    \qmlproperty stringList xcode::availableSdkVersions
    \readonly

    The version numbers of all SDK available in the Xcode installation for the
    current platform.

    For example, \c {[10.9, 10.10]}.

    \defaultvalue \l{xcode::}{developerPath}
*/

/*!
    \qmlproperty path xcode::platformPath
    \readonly

    The path of the platform directory containing \l{xcode::}{sdkPath}.

    \defaultvalue \l{xcode::}{developerPath}
*/

/*!
    \qmlproperty path xcode::sdkPath
    \readonly

    The path of the SDK used to build products. Equivalent to
    \l{qbs::sysroot}{qbs.sysroot}.

    \defaultvalue Determined by \l{xcode::}{developerPath} and \l{xcode::}{sdk}.
*/