aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/modules/java-module.qdoc
blob: 9ec18d0b8c257066938798cacf8b59d4a2186ae8 (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
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia.  For licensing terms and
** conditions see http://www.qt.io/licensing.  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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

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

    \title Module java
    \brief Provides Java support.

    The \c java module contains the properties and rules for building Java projects.

    \section1 Java Properties

    \table
    \header
        \li Property
        \li Type
        \li Default
        \li Description
    \row
        \li additionalClassPaths
        \li stringList
        \li undefined
        \li Locations beside this product's class output path to consider when compiling.
    \row
        \li additionalCompilerFlags
        \li stringList
        \li undefined
        \li Use this to supply compiler flags not covered by any of the properties in this module.
    \row
        \li additionalJarFlags
        \li stringList
        \li undefined
        \li Use this to supply archiver flags not covered by any of the properties in this module.
    \row
        \li bootClassPaths
        \li stringList
        \li undefined
        \li Use this if you need to specify non-standard bootstrap class files.
    \row
        \li compilerFilePath
        \li string
        \li \c compilerName, prefixed by \c jdkPath if it is defined
        \li The command to invoke when compiling Java sources.
    \row
        \li compilerName
        \li string
        \li \c{"javac"}
        \li The file name of the Java compiler.
    \row
        \li enableWarnings
        \li bool
        \li \c true
        \li Controls whether warnings are emitted when compiling Java sources.
    \row
        \li interpreterFilePath
        \li string
        \li \c interpreterName, prefixed by \c jdkPath if it is defined
        \li The command to invoke when executing Java code.
    \row
        \li interpreterName
        \li string
        \li \c{"java"}
        \li The file name of the Java interpreter.
    \row
        \li jarFilePath
        \li string
        \li \c jarName, prefixed by \c jdkPath if it is defined
        \li The command to run when creating or extracting \c jar files.
    \row
        \li jarName
        \li string
        \li \c{"jar"}
        \li The file name of the \c jar tool.
    \row
        \li jdkPath
        \li path
        \li undefined
        \li The base path of Java-related tools.
    \row
        \li languageVersion
        \li string
        \li undefined
        \li The Java language version to interpret source code as. If undefined, the compiler
            will use its default.
    \row
        \li runtimeVersion
        \li string
        \li undefined
        \li The version of the Java runtime to generate compatible bytecode for. If undefined,
            the compiler will use its default.
    \row
        \li warningsAsErrors
        \li bool
        \li \c false
        \li If this property is enabled, the compiler will abort where it would normally emit
            a warning.
    \endtable
*/