aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/items/language/scanner.qdoc6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/reference/items/language/scanner.qdoc b/doc/reference/items/language/scanner.qdoc
index 90e5ad63a..9ec575684 100644
--- a/doc/reference/items/language/scanner.qdoc
+++ b/doc/reference/items/language/scanner.qdoc
@@ -98,7 +98,11 @@
dependencies.
The code in this script is treated as a function with the signature
- \c{function(project, product, input)}.
+ \c{function(project, product, input, filePath)}, where \c input is
+ the artifact at which the scan originated, and \c filePath is the
+ currently scanned file. For non-recursive scans, \c filePath is
+ always equal to \c{input.filePath}.
+
\nodefaultvalue
*/