aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/modules/android-sdk-module.qdoc
blob: e89ef25c5e05210ecdfbc5b153db5b5e0fc05aeb (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
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of the Qt Build Suite.
**
** 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 http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

/*!
    \contentspage index.html
    \page android-sdk-module.html
    \ingroup list-of-modules

    \title Module Android.sdk
    \since 1.4
    \brief Provides support for building Android packages.

    The \c Android.sdk module contains the properties and rules to create Android application
    packages from Java sources, resources and so on.

    Normally, you will not use this module directly, but instead work
    with the \l{AndroidApk Item}{AndroidApk item} that \QBS provides.

    \section1 Android.sdk Properties

    These properties are set automatically when creating an Android profile via the
    \c setup-android tool.

    \table
    \header
        \li Property
        \li Type
        \li Since
        \li Default
        \li Description
    \row
        \li buildToolsVersion
        \li string
        \li 1.4
        \li undefined
        \li The version of the build tools such as aapt and dx. The \c setup-android
            tool sets this to the highest version available in the SDK.
    \row
        \li ndkDir
        \li string
        \li 1.4
        \li undefined
        \li The NDK base directory, if an NDK is present.
    \row
        \li platform
        \li string
        \li 1.4
        \li undefined
        \li The versioned platform name (e.g. "android-21"). The \c setup-android
            tool sets this to the highest version available in the SDK.
    \row
        \li sdkDir
        \li string
        \li 1.4
        \li undefined
        \li The SDK base directory.
    \endtable

    \section1 Relevant File Tags

    \table
    \header
        \li Tag
        \li Auto-tagged File Names
        \li Since
        \li Description
    \row
        \li \c{"android.aidl"}
        \li \c{*.aidl}
        \li 1.4.0
        \li This tag is used for Android AIDL files. One Java source file will be generated for each
            such file.
    \row
        \li \c{"android.assets"}
        \li -
        \li 1.4.0
        \li This tag is used for Android assets, which are typically located in an \c{assets/}
            subdirectory. Using the \l {AndroidApk Item}{AndroidApk} item takes care of tagging
            these files for you.
    \row
        \li \c{"android.apk"}
        \li n/a
        \li 1.4.0
        \li This tag is attached to the output artifact of the rule that creates an APK package.
            It is the default type of the \l {AndroidApk Item}{AndroidApk} item.
    \row
        \li \c{"android.manifest"}
        \li \c{AndroidManifest.xml}
        \li 1.4.0
        \li This tag is used for the Android manifest. There must be one such file for every
            Android app.
    \row
        \li \c{"android.resources"}
        \li -
        \li 1.4.0
        \li This tag is used for Android resources, which are typically located in a \c{res/}
            subdirectory. Using the \l {AndroidApk Item}{AndroidApk} item takes care of tagging
            these files for you.
    \endtable
*/