Document the fact that PathProbe.candidatePaths is always populated

Even when PathProbe.found is false

Change-Id: I52ee359d498076d017865c739a9ceb1d575aa2a1
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>

1 files changed, 18 insertions, 0 deletions

diff --git a/doc/reference/items/probe/path-probe.qdoc b/doc/reference/items/probe/path-probe.qdoc
index eaaee9e54..c1088a9cf 100644
--- a/doc/reference/items/probe/path-probe.qdoc
+++ b/doc/reference/items/probe/path-probe.qdoc
@@ -169,6 +169,24 @@
     This property contains the result list of all paths that were checked before a file was found
     (including the file names).
 
+    This property is set even if the Probe didn't find anything and can be used to give the user
+    a hint what went wrong:
+    \code
+    Module {
+        Probes.BinaryProbe {
+            id: pythonProbe
+            names: "python"
+        }
+        validate: {
+            if (!pythonProbe.found) {
+                throw ModUtils.ModuleError(
+                        "Could not find python binary at any of the following locations:\n\t" +
+                        pythonProbe.candidatePaths.join("\n\t"));
+            }
+        }
+    }
+    \endcode
+
     \nodefaultvalue
 */