aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/modules/android-ndk-module.qdoc
blob: 08f54a9c9ee61b1beca38539ec80c735d04c15ab (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
/****************************************************************************
**
** Copyright (C) 2017 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
    \qmltype Android.ndk
    \inqmlmodule QbsModules
    \since Qbs 1.4

    \brief Provides support for building native Android libraries.

    The \c Android.ndk module contains the properties and rules to create native libraries
    for use in Android applications.

    Normally, you will not use this module directly, but instead work
    with the \l{DynamicLibrary}, \l{StaticLibrary} and \l Application items
    that \QBS provides.

    Here is what the project file for the \c hello-jni example that comes with
    the NDK could look like:

    \code
        CppApplication {
            name: "HelloJni"
            Android.sdk.packageName: "com.example.hellojni"
            qbs.architectures: ["mips", "x86"]
            files: "app/src/main/jni/hello-jni.c"
        }
    \endcode

    \section2 Relevant File Tags
    \target filetags-android-ndk

    \table
    \header
        \li Tag
        \li Since
        \li Description
    \row
        \li \c{"android.nativelibrary"}
        \li 1.4.0
        \li Attached to dynamic libraries that will end up in APK packages.
            You do not normally need to use the tag explicitly, as it is the
            default type of the \l{DynamicLibrary} item for Android targets.
    \endtable
*/

/*!
    \qmlproperty string Android.ndk::abi

    The ABI name as it appears under \c "lib/" in the application package.
    Corresponds to \c APP_ABI in \c Android.mk.

    \nodefaultvalue
*/

/*!
    \qmlproperty string Android.ndk::appStl

    The library to use for C++. The possible values are:

    \list
        \li \c "c++_shared"
        \li \c "c++_static"
        \li \c "gabi++_shared"
        \li \c "gabi++_static"
        \li \c "gnustl_shared"
        \li \c "gnustl_static"
        \li \c "stlport_shared"
        \li \c "stlport_static"
        \li \c "system"
    \endlist

    \defaultvalue \c{"system"}
*/

/*!
    \qmlproperty path Android.ndk::ndkDir

    The NDK base directory.

    \nodefaultvalue
*/

/*!
    \qmlproperty string Android.ndk::platform

    The versioned platform name.

    \defaultvalue \c{"android-9"}
*/