aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/items/language/parameters.qdoc
blob: 325f1680ee1165f57388d0abf520a5350065829b (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
/****************************************************************************
**
** 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$
**
****************************************************************************/
/*!
    \previouspage Parameter
    \nextpage Probe
    \qmltype Parameters
    \inqmlmodule QbsLanguageItems
    \ingroup list-of-items
    \keyword QML.Parameters

    \brief Defines default values for dependency parameters within Export items.

    The Parameters item defines default values for dependency parameters within
    \l{Export} items.

    Example:
    \code
    DynamicLibrary {
       name: "foo"
       ...
       Export {
           ...
           Parameters {
               cpp.link: false
           }
       }
    }
    \endcode

    Every dependency on \e{foo} has the parameter \l{dependency-parameters-cpp}
    {cpp.link} set to \c{false} by default.

    This can be overridden explicitly:
    \code
    Depends { name: "foo"; cpp.link: true }
    \endcode

    The Parameters item contains a number of property bindings where
    each property must be a properly declared dependency parameter.
    For more information, see \l{Parameter} and
    \l{Module#dependency-parameters}{Module - Dependency Parameters}.
*/