QTemporaryFile: de-duplicate API docs wrt. default file name template

This also fixes a discrepancy in fileTemplate() API docs.

Pick-to: 6.7
Change-Id: Ie36278417406848db2a9759e996ce98b87d19f89
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
(cherry picked from commit 7fc2eae710c885e5152ed37c75fe6993c36c7171)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Ahmad Samir 2024-07-01 01:17:16 +03:00 committed by Qt Cherry-pick Bot
parent 9bccfb80bb
commit b7170f97d4

View File

@ -633,12 +633,17 @@ QTemporaryFile::QTemporaryFile(const QString &templateName)
#else
/*!
Constructs a QTemporaryFile using as file template
the application name returned by QCoreApplication::applicationName()
(otherwise \c qt_temp) followed by ".XXXXXX".
The file is stored in the system's temporary directory, QDir::tempPath().
Constructs a QTemporaryFile.
\sa setFileTemplate(), QDir::tempPath()
//! [default-file-name-template]
\keyword Default File Name Template
The default file name template is determined from the application name as
returned by QCoreApplication::applicationName() (or \c {"qt_temp"} if the
application name is empty), followed by \c {".XXXXXX"}. The file is stored
in the system's temporary directory, as returned by QDir::tempPath().
//! [default-file-name-template]
\sa setFileTemplate(), fileTemplate(), fileName(), QDir::tempPath()
*/
QTemporaryFile::QTemporaryFile()
: QTemporaryFile(nullptr)
@ -672,10 +677,9 @@ QTemporaryFile::QTemporaryFile(const QString &templateName)
}
/*!
Constructs a QTemporaryFile (with the given \a parent)
using as file template the application name returned by QCoreApplication::applicationName()
(otherwise \c qt_temp) followed by ".XXXXXX".
The file is stored in the system's temporary directory, QDir::tempPath().
Constructs a QTemporaryFile with the given \a parent.
\include qtemporaryfile.cpp default-file-name-template
\sa setFileTemplate()
*/
@ -796,10 +800,9 @@ QString QTemporaryFile::fileName() const
}
/*!
Returns the set file template. The default file template will be
called qcoreappname.XXXXXX and be placed in QDir::tempPath().
Returns the file name template.
\sa setFileTemplate()
\sa setFileTemplate(), fileName(), {Default File Name Template}
*/
QString QTemporaryFile::fileTemplate() const
{