aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@theqtcompany.com>2016-07-01 15:42:25 +0200
committerChristian Kandeler <christian.kandeler@qt.io>2016-07-07 13:43:45 +0000
commit105004b47eb43675613de6ec436c7495c86f4332 (patch)
treef5823cfeed178577908944c512a2c54baba5796e /doc
parentcadb0864c99876b54fbdc46677cfb9d16162c096 (diff)
Allow to check for module version
Introduce a "version" property to the Module item and corresponding properties to the Depends item to set constraints on that version. [ChangeLog] Introduced the ability to check a module's version in a Depends item. Change-Id: I583b40216fb91af21f4e79ad403a7e327215ff79 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Jake Petroules <jake.petroules@qt.io> Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/items/depends.qdoc15
-rw-r--r--doc/reference/items/module.qdoc6
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/reference/items/depends.qdoc b/doc/reference/items/depends.qdoc
index cdc45dd8c..f3941f8d4 100644
--- a/doc/reference/items/depends.qdoc
+++ b/doc/reference/items/depends.qdoc
@@ -46,6 +46,7 @@
Depends { name: "cpp" }
Depends {
name: "awesome_module"
+ versionAtLeast: "2.0"
required: false
}
Depends {
@@ -77,6 +78,20 @@
\li true
\li Determines whether the dependency will actually be applied.
\row
+ \li versionAtLeast
+ \li string
+ \li undefined
+ \li The minimum value that the dependency's \c version property needs to have. If the
+ actual version is lower than that, loading the dependency will fail.
+ The value consists of integers separated by dots.
+ \row
+ \li versionBelow
+ \li string
+ \li undefined
+ \li A value that the dependency's \c version property must be lower than. If the
+ actual version is equal to or higher than that, loading the dependency will fail.
+ The value consists of integers separated by dots.
+ \row
\li productTypes
\li stringList
\li undefined
diff --git a/doc/reference/items/module.qdoc b/doc/reference/items/module.qdoc
index 28a80e9e3..aa1e7d1bc 100644
--- a/doc/reference/items/module.qdoc
+++ b/doc/reference/items/module.qdoc
@@ -193,5 +193,11 @@
\li \c undefined
\li Script that is run after the module is loaded. It can be used to check property
values and throw errors in unexpected cases. The return value is ignored.
+ \row
+ \li version
+ \li string
+ \li \c undefined
+ \li The module's version. It consists of integer values separated by dots. You can check
+ for specific values of this property in a \l{Depends item}{Depends} item.
\endtable
*/