From 2f35f69985b63fd9215bc19e06a8d0e8b3d87e1c Mon Sep 17 00:00:00 2001 From: Ahmad Samir Date: Sun, 24 Mar 2024 18:51:26 +0200 Subject: [PATCH] QFileSystemEngine: add a brief description May be helpful for the next dev to read this code. Change-Id: I26947984c67d21bd989883e5a9439e2675fec180 Reviewed-by: Thiago Macieira Reviewed-by: Edward Welbourne --- src/corelib/io/qfilesystemengine.cpp | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/corelib/io/qfilesystemengine.cpp b/src/corelib/io/qfilesystemengine.cpp index e7f87971712..c69ac381020 100644 --- a/src/corelib/io/qfilesystemengine.cpp +++ b/src/corelib/io/qfilesystemengine.cpp @@ -13,6 +13,21 @@ QT_BEGIN_NAMESPACE +/*! \class QFileSystemEngine + \internal + + QFileSystemEngine offers OS-independent API for native system library + methods, which work with files on physical disk drives; using such methods + directly is faster than using a custom file engine (see QAbstractFileEngine + and its sub-classes). Typically, you need a custom file engine when working + with virtual file systems (for example QResource). Various Qt classes, + for example QDir, QFile, and QFileInfo, can handle both types of files by + detecting the file path scheme, for example, \c file:///, \c :/someresource + (QResource). + + \sa QAbstractFileEngine, QAbstractFileEngineHandler, QFSFileEngine, QResourceFileEngine +*/ + /*! \internal