Doc: provide a code example of QDirIterator's nameFilters parameter

Change-Id: I56f9251f17bab0f835979a5feadec1fa896c9d69
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
(cherry picked from commit 0c52e600b3b5c83d128e6b4068d523829357fef0)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>

2 files changed, 10 insertions, 1 deletions

diff --git a/src/corelib/doc/snippets/code/src_corelib_io_qdiriterator.cpp b/src/corelib/doc/snippets/code/src_corelib_io_qdiriterator.cpp
index 31442a5516..56cf9ed699 100644
--- a/src/corelib/doc/snippets/code/src_corelib_io_qdiriterator.cpp
+++ b/src/corelib/doc/snippets/code/src_corelib_io_qdiriterator.cpp
@@ -69,3 +69,7 @@ while (it.hasNext()) {
     qDebug() << f.fileName() << f.readAll().trimmed().toDouble() / 1000 << "MHz";
 }
 //! [1]
+
+//! [2]
+QDirIterator audioFileIt(audioPath, {"*.mp3", "*.wav"}, QDir::Files);
+//! [2]
diff --git a/src/corelib/io/qdiriterator.cpp b/src/corelib/io/qdiriterator.cpp
index 1cf6b1be08..7411eab68b 100644
--- a/src/corelib/io/qdiriterator.cpp
+++ b/src/corelib/io/qdiriterator.cpp
@@ -483,10 +483,15 @@ QDirIterator::QDirIterator(const QString &path, IteratorFlags flags)
     By default, \a flags is NoIteratorFlags, which provides the same behavior
     as QDir::entryList().
 
+    For example, the following iterator could be used to iterate over audio
+    files:
+
+    \snippet code/src_corelib_io_qdiriterator.cpp 2
+
     \note To list symlinks that point to non existing files, QDir::System must be
      passed to the flags.
 
-    \sa hasNext(), next(), IteratorFlags
+    \sa hasNext(), next(), IteratorFlags, QDir::setNameFilters()
 */
 QDirIterator::QDirIterator(const QString &path, const QStringList &nameFilters,
                            QDir::Filters filters, IteratorFlags flags)