diff options
authorChristian Kandeler <christian.kandeler@qt.io>2017-01-05 16:31:22 +0100
committerChristian Kandeler <christian.kandeler@qt.io>2017-01-05 16:58:22 +0000
commita6533f11d5d7129a86cfccf3248aa62081f31588 (patch)
parentbde133890a445112ae32367bdfaed489174ef3c8 (diff)
Clean up the documentation for the Scanner item
Change-Id: Ie80e267263a59458862cfcfb54394b702e201d28 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/reference/items/language/scanner.qdoc b/doc/reference/items/language/scanner.qdoc
index 44c93d168..62fcb643c 100644
--- a/doc/reference/items/language/scanner.qdoc
+++ b/doc/reference/items/language/scanner.qdoc
@@ -35,20 +35,19 @@
\title Scanner Item
\brief Creates custom dependency scanners in modules.
- An \c Scanner item can appear inside a \l{Module Item}, and allows to define
- artifacts dependency, according to the artifacts contents.
- For example scanner for "qrc" files:
+ A \c Scanner item can appear inside a \l{Module Item}, and allows to extract
+ dependencies for artifacts from the artifacts' file contents.
+ For example, this is what a scanner for "qrc" files might look like:
import qbs.Xml
Module {
Scanner {
- condition: true
inputs: 'qrc'
scan: {
var xml = new XmlDomDocument(input.filePath);
dependencies = [];
- // do something with the xml
+ // retrieve <file> entries from the XML document
return dependencies;
@@ -76,7 +75,7 @@
\li recursive
\li bool
\li false
- \li Determines whether to scan dependencies recursively.
+ \li Determines whether to scan the returned dependencies using the same scanner.
\li searchPaths
\li script