summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@theqtcompany.com>2016-06-27 14:06:06 +0200
committerChristian Kandeler <christian.kandeler@theqtcompany.com>2016-06-27 14:16:42 +0200
commit2ea9e28a6963cae217923d77fd00f581306b1980 (patch)
treef8d616d4bf4638ba57fcc37856840d6c3ed8e7e2 /doc
parente34d268ba9edc2f73c9dc1f8fca42f5206646a0c (diff)
parent0b0832aaf4cc26bee202207c8cbe64650ee2d2fd (diff)
downloadqbs-2ea9e28a6963cae217923d77fd00f581306b1980.tar.gz
Merge 1.5 into master.
Change-Id: I0d15404445ffbadfd5fb2277630650928bb24b05
Diffstat (limited to 'doc')
-rw-r--r--doc/qbs.qdoc42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc
index d85f992e6..7cacb06d3 100644
--- a/doc/qbs.qdoc
+++ b/doc/qbs.qdoc
@@ -551,6 +551,48 @@
cpp.optimization: qbs.buildVariant == "debug" ? "none" : "fast"
\endcode
+ \section1 Property Types
+
+ While properties in \QBS generally work the same way as in QML, the set of possible property
+ types has been adapted to reflect the specific needs of a build tool. The supported types
+ are as follows:
+
+ \table
+ \header
+ \li Property type
+ \li Example
+ \li Description
+ \row
+ \li \c bool
+ \li \c{property bool someBoolean: false}
+ \li The usual boolean values.
+ \row
+ \li \c int
+ \li \c{property int theAnswer: 42}
+ \li Integral numbers.
+ \row
+ \li \c path
+ \li \c{property path aFile: "file.txt"}
+ \li File paths resolved relative to the directory the product they are associated with
+ is located in.
+ \row
+ \li \c pathList
+ \li \c{property pathList twoFiles: ["file1.txt", "./file2.txt"]}
+ \li A list of \c path values.
+ \row
+ \li \c string
+ \li \c{property string parentalAdvisory: "explicit lyrics"}
+ \li JavaScript strings.
+ \row
+ \li \c stringList
+ \li \c{property stringList realWorldExample: ["no", "not really"]}
+ \li A list of JavaScript strings.
+ \row
+ \li \c var
+ \li \c{property var aMap: ({ key1: "value1", key2: "value2" })}
+ \li Generic data, as in QML.
+ \endtable
+
\section1 File Tags and Taggers