File: artifact.qdoc

package info (click to toggle)
qbs 1.24.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 55,076 kB
  • sloc: cpp: 271,027; javascript: 105,678; ansic: 6,702; python: 5,724; yacc: 1,847; asm: 1,731; sh: 959; java: 693; perl: 562; objc: 409; lex: 194; xml: 141; makefile: 50; cs: 41
file content (85 lines) | stat: -rw-r--r-- 2,778 bytes parent folder | download | duplicates (11)
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
/****************************************************************************
**
** 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$
**
****************************************************************************/
/*!
    \nextpage Depends
    \ingroup list-of-language-items
    \qmltype Artifact
    \inqmlmodule QbsLanguageItems
    \ingroup list-of-items
    \keyword QML.Artifact

    \brief Describes a file produced by a Rule.

    An Artifact represents a single file produced by a \l{Rule}.

    For example, if a rule produces three files, it needs to contain three
    Artifact items.

    In addition to Artifact properties, you can set module properties within an
    Artifact item, as follows:

    \code
    Artifact {
        filePath: "somefile.cpp"
        fileTags: ["cpp"]
        cpp.cxxLanguageVersion: "c++11"
        // ...
    }
    \endcode

    \note The code on the right-hand side of Artifact properties has access to
    the set of input artifacts. That is, it can refer to the \c inputs map and,
    if the rule is not a multiplex rule, the \c input variable.
*/

/*!
    \qmlproperty bool Artifact::alwaysUpdated

    Setting this property to \c false means the file is not necessarily always
    written to by any command run by the rule.
    If all artifacts of a rule have this property set to \c false, the commands
    of the rule are only executed if all of them are out of date compared to the inputs.

    \defaultvalue \c true
*/

/*!
    \qmlproperty string Artifact::filePath

    The file path of the target artifact.

    \nodefaultvalue
*/

/*!
    \qmlproperty stringList Artifact::fileTags

    A list of tags to attach to the target file. These can then be matched by a
    \l{Rule}.

    \defaultvalue An empty list
*/