diff options
| author | Kai Koehne <kai.koehne@digia.com> | 2013-02-26 16:14:41 +0100 |
|---|---|---|
| committer | Kai Koehne <kai.koehne@digia.com> | 2013-02-28 10:19:06 +0100 |
| commit | 5df05c0a9cef3a041d9c5dd8b5838712759a8e5e (patch) | |
| tree | fa4b12d7d2cd902d00d326744c4fa69afd3b2e02 /doc/scripting.qdoc | |
| parent | 0eb397ba65a23a09eb3673bd4fbe3e3248ceb00a (diff) | |
Doc: Fix documentation on predefined variables
Change-Id: I805a07f007cddb9fe62db986968f9f79511ffe1f
Reviewed-by: Tim Jenssen <tim.jenssen@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Diffstat (limited to 'doc/scripting.qdoc')
| -rw-r--r-- | doc/scripting.qdoc | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/scripting.qdoc b/doc/scripting.qdoc index 70ecc8ed0..3bfe1a2b7 100644 --- a/doc/scripting.qdoc +++ b/doc/scripting.qdoc @@ -250,7 +250,14 @@ \o Current platform: \c "x11", \c "win", or \c "mac". \endtable - \note You can use the variables in the parameter list for installation - operations. For example, \c{"{TargetDir}/settings.xml"} might be expanded - to: \c{"C:/Program Files/My Program/settings.xml"}. + The variables can be resolved by calls to \c installer.value(). If embedded + in '@' they can also be part of strings passed as arguments to installation + operations: + + \code + if (installer.value("os") === "win") { + component.addOperation("CreateShortcut", "@TargetDir@/MyApp.exe", "@StartMenuDir@/MyApp.lnk"); + } + \endcode + */ |