diff options
Diffstat (limited to 'doc/reference/items/language/scanner.qdoc')
-rw-r--r-- | doc/reference/items/language/scanner.qdoc | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/doc/reference/items/language/scanner.qdoc b/doc/reference/items/language/scanner.qdoc new file mode 100644 index 000000000..44c93d168 --- /dev/null +++ b/doc/reference/items/language/scanner.qdoc @@ -0,0 +1,95 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qbs. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ +/*! + \contentspage list-of-language-items.html + \previouspage rule-item.html + \page scanner-item.html + \nextpage subproject-item.html + \ingroup list-of-language-items + \ingroup list-of-items + + \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: + \code + import qbs.Xml + + Module { + Scanner { + condition: true + inputs: 'qrc' + scan: { + var xml = new XmlDomDocument(input.filePath); + dependencies = []; + // do something with the xml + return dependencies; + } + } + } + \endcode + + \section1 Scanner Properties + \table + \header + \li Property + \li Type + \li Default + \li Description + \row + \li condition + \li bool + \li true + \li If true, the scanner is enabled, otherwise it does nothing. + \row + \li inputs + \li string list + \li undefined + \li File tags the input artifacts must match. + \row + \li recursive + \li bool + \li false + \li Determines whether to scan dependencies recursively. + \row + \li searchPaths + \li script + \li undefined + \li Script that returns paths to look for dependencies. + The code in this script is treated as a function with the signature + \c{function(project, product, input)}. + \row + \li scan + \li script + \li undefined + \li Script that reads the input artifact and returns string list with dependencies. + The code in this script is treated as a function with the signature + \c{function(project, product, input)}. + \endtable +*/ |