aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@qt.io>2016-12-05 18:04:35 +0100
committerChristian Kandeler <christian.kandeler@qt.io>2016-12-06 10:57:48 +0000
commita4de37a2be7d4e54be521d324d9d58aa39f13d91 (patch)
treeef31de20deb029ef0471ec8de6c0853abb14fa22
parent71dc20dc06dd52815798d1fd480fde57a4eca42d (diff)
Document how to set module properties on generated artifacts
Task-number: QBS-1056 Change-Id: Id9c0031c3b8cdbffdb3a67a9545a0e67b9dda508 Reviewed-by: Denis Klychkov <kd.snake@gmail.com> Reviewed-by: Jake Petroules <jake.petroules@qt.io>
-rw-r--r--doc/reference/items/artifact.qdoc11
-rw-r--r--doc/reference/items/rule.qdoc6
2 files changed, 16 insertions, 1 deletions
diff --git a/doc/reference/items/artifact.qdoc b/doc/reference/items/artifact.qdoc
index 09db7502e..0294184d9 100644
--- a/doc/reference/items/artifact.qdoc
+++ b/doc/reference/items/artifact.qdoc
@@ -38,6 +38,17 @@
For example, if a rule produces three files, it needs to contain three Artifact items.
+ In addition to the properties listed in the section below, you can also set module properties
+ within an \c Artifact item:
+ \code
+ Artifact {
+ filePath: "somefile.cpp"
+ fileTags: ["cpp"]
+ cpp.cxxLanguageVersion: "c++11"
+ // ...
+ }
+ \endcode
+
\section1 Artifact Properties
\note The code on the right-hand side of these properties has access to the set of input
diff --git a/doc/reference/items/rule.qdoc b/doc/reference/items/rule.qdoc
index f51b3f76b..379a5ec83 100644
--- a/doc/reference/items/rule.qdoc
+++ b/doc/reference/items/rule.qdoc
@@ -242,7 +242,11 @@
\li An array of output artifacts, specified as JavaScript objects.
Example:
\code
- outputArtifacts: [{filePath: "myfile.txt", fileTags: ["foo", "bar"]}]
+ outputArtifacts: [{
+ filePath: "myfile.cpp",
+ fileTags: ["cpp"],
+ cpp: { cxxLanguageVersion: "c++11" }
+ }]
\endcode
For a description of the possible properties, see the documentation of the
\l{Artifact item}.