aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/modules/android-ndk-module.qdoc
blob: 5f35da18b77cb9a34b666b7132c07ce6e6575274 (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) 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-ndk-module.html
    \ingroup list-of-modules

    \title Module Android.ndk
    \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 \l{AndroidApk Item}{Android application packages}.

    Normally, you will not use this module directly, but instead work
    with the \l{DynamicLibrary Item}{DynamicLibrary} and \l{StaticLibrary Item}{StaticLibrary}
    items that \QBS provides.
    Here is what the project file for the "hello-jni" example that comes with the NDK could look
    like:
    \code
        import qbs

        Project {
            DynamicLibrary {
                name: "hello-jni"
                architectures: ["mips", "x86"]
                files: ["jni/hello-jni.c"]
            }

            AndroidApk {
                name: "HelloJni"
                packageName: "com.example.hellojni"
                Depends { productTypes: ["android.nativelibrary"] }
            }
        }
    \endcode

    \section1 Android.ndk Properties

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

    \table
    \header
        \li Property
        \li Type
        \li Default
        \li Description
    \row
        \li abi
        \li string
        \li undefined
        \li The ABI name as it appears under "lib/" in the application package.
    \row
        \li appStl
        \li string
        \li \c{"system"}
        \li The library to use for C++. The possible values are: "system", "gabi++_static",
            "gabi++_shared", "stlport_static", "stlport_shared", "gnustl_static", "gnustl_shared",
            "c++_static", "c++_shared".
    \row
        \li buildProfile
        \li string
        \li undefined
        \li The name of the build profile, e.g. "armeabi-v7a-hard".
    \row
        \li enableExceptions
        \li bool
        \li \c{appStl !== "system"}
        \li Whether to enable exceptions in C++ code.
    \row
        \li enableRtti
        \li bool
        \li \c{appStl !== "system"}
        \li Whether to enable runtime type information in C++ code.
    \row
        \li ndkDir
        \li path
        \li undefined
        \li The NDK base directory.
    \row
        \li platform
        \li string
        \li \c{"android-9"}
        \li The versioned platform name.
    \endtable

*/