Skip to content

Commit

Permalink
Doc: silence some warnings from QDirListing
Browse files Browse the repository at this point in the history
The type doesn't have hasNext/next member functions, and
the fileInfo/fileName/filePath functions are members of the
nested DirEntry type.

Since the DirEntry type is not documented, linking to it will
still fail. Adding documentation for that type is an exercise
for a future commit.

Amends c39a0d1.

Pick-to: 6.8
Change-Id: Ib223905123264271ce090a991cd73936b49edaae
Reviewed-by: Ahmad Samir <[email protected]>
  • Loading branch information
vohi committed Jun 5, 2024
1 parent 82cba0c commit 71053ab
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/corelib/io/qdirlisting.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ bool QDirListingPrivate::hasIterators() const
\note To list symlinks that point to non existing files, QDir::System
must be set in \a dir's QDir::Filters.
\sa hasNext(), next(), IteratorFlags
\sa IteratorFlags
*/
QDirListing::QDirListing(const QDir &dir, IteratorFlags flags)
: d(new QDirListingPrivate)
Expand All @@ -421,7 +421,7 @@ QDirListing::QDirListing(const QDir &dir, IteratorFlags flags)
\note To list symlinks that point to non existing files, QDir::System
must be set in \a filters.
\sa hasNext(), next(), IteratorFlags
\sa IteratorFlags
*/
QDirListing::QDirListing(const QString &path, QDir::Filters filters, IteratorFlags flags)
: d(new QDirListingPrivate)
Expand All @@ -439,7 +439,7 @@ QDirListing::QDirListing(const QString &path, QDir::Filters filters, IteratorFla
By default, \a flags is NoIteratorFlags, which provides the same behavior
as in QDir::entryList().
\sa hasNext(), next(), IteratorFlags
\sa IteratorFlags
*/
QDirListing::QDirListing(const QString &path, IteratorFlags flags)
: d(new QDirListingPrivate)
Expand All @@ -466,7 +466,7 @@ QDirListing::QDirListing(const QString &path, IteratorFlags flags)
\note To list symlinks that point to non existing files, QDir::System
must be set in \a flags.
\sa hasNext(), next(), IteratorFlags, QDir::setNameFilters()
\sa IteratorFlags, QDir::setNameFilters()
*/
QDirListing::QDirListing(const QString &path, const QStringList &nameFilters, QDir::Filters filters,
IteratorFlags flags)
Expand Down Expand Up @@ -524,7 +524,7 @@ QString QDirListing::iteratorPath() const
Here's how to find and read all files filtered by name, recursively:
\snippet code/src_corelib_io_qdirlisting.cpp 1
\sa fileInfo(), fileName(), filePath()
\sa QDirListing::DirEntry
*/
QDirListing::const_iterator QDirListing::begin() const
{
Expand Down

0 comments on commit 71053ab

Please sign in to comment.