From af9b70c5edc2a46bba18ef3753022adb5810292a Mon Sep 17 00:00:00 2001
From: Ahmad Samir <a.samirh78@gmail.com>
Date: Thu, 4 Jan 2024 14:55:48 +0200
Subject: [PATCH] QFileInfoGatherer: add some API docs

Task-number: QTBUG-99750
Pick-to: 6.6
Change-Id: I908e1135b895dbf6116b1dce7416b14905b886b2
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
(cherry picked from commit 0cda986eb6cdf681cb64811b416c413645cb0f3d)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
---
 src/gui/itemmodels/qfileinfogatherer.cpp | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/gui/itemmodels/qfileinfogatherer.cpp b/src/gui/itemmodels/qfileinfogatherer.cpp
index 94981b482e7..5156a3f21f9 100644
--- a/src/gui/itemmodels/qfileinfogatherer.cpp
+++ b/src/gui/itemmodels/qfileinfogatherer.cpp
@@ -249,6 +249,15 @@ bool QFileInfoGatherer::isWatching() const
     return result;
 }
 
+/*! \internal
+
+    If \a v is \c false, the QFileSystemWatcher used internally will be deleted
+    and subsequent calls to watchPaths() will do nothing.
+
+    If \a v is \c true, subsequent calls to watchPaths() will add those paths to
+    the filesystem watcher; watchPaths() will initialize a QFileSystemWatcher if
+    one hasn't already been initialized.
+*/
 void QFileInfoGatherer::setWatching(bool v)
 {
 #if QT_CONFIG(filesystemwatcher)