aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Weickelt <richard@weickelt.de>2019-01-03 22:15:11 +0100
committerRichard Weickelt <richard@weickelt.de>2019-01-07 13:19:53 +0000
commite5ba24302d9e1d55c544c8616f837af9cfbbf710 (patch)
tree55508ae11af6b5ff4f028d06d0ad50584667d51c
parent2095b8ad88f39c0bc66527fbbc681f3028f74b4b (diff)
Add documentation of cpp.toolchainInstallPath property
The property is undocumented, but plays a central role in most toolchain setups. Therefore it should be documented. Fixes: QBS-1422 Change-Id: I9d1044733e6b99862f137849502e5b1a35a4c192 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--doc/reference/modules/cpp-module.qdoc12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/reference/modules/cpp-module.qdoc b/doc/reference/modules/cpp-module.qdoc
index bf1080dd7..9cf7d6a0f 100644
--- a/doc/reference/modules/cpp-module.qdoc
+++ b/doc/reference/modules/cpp-module.qdoc
@@ -784,6 +784,18 @@
*/
/*!
+ \qmlproperty string cpp::toolchainInstallPath
+
+ The directory path where the toolchain is installed. This property is set
+ in the build profile.
+
+ This is usually the base property from which all compiler and tool paths
+ are automatically derived.
+
+ \defaultvalue Determined by \l{setup-toolchains}{qbs setup-toolchains}.
+*/
+
+/*!
\qmlproperty string cpp::assemblerPath
\since Qbs 1.5