summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2021-06-23 09:33:10 +0200
committerPaul Wicking <paul.wicking@qt.io>2021-06-23 20:09:46 +0200
commitcc2fdce35e6a958e021b4d4cdc0ace1a91b06d0c (patch)
tree9aef672984f312d268ec196e1438e7d235221d50 /src
parentcbe65673b24bbe504223ee37511b298642415c81 (diff)
Extend documentation for QFile:copy()
- Add information about symlinks and file metadata. - Reflow text. - Extract text common to both overloads to a .qdocinc file for consistency and to avoid duplication. Pick-to: 6.2 6.1 5.15 Fixes: QTBUG-94706 Change-Id: I3c730fd63f4018a1a573bb56751fedd2270a3247 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Diffstat (limited to 'src')
-rw-r--r--src/corelib/doc/src/includes/qfile-copy.qdocinc11
-rw-r--r--src/corelib/io/qfile.cpp14
2 files changed, 15 insertions, 10 deletions
diff --git a/src/corelib/doc/src/includes/qfile-copy.qdocinc b/src/corelib/doc/src/includes/qfile-copy.qdocinc
new file mode 100644
index 0000000000..5ff68eac81
--- /dev/null
+++ b/src/corelib/doc/src/includes/qfile-copy.qdocinc
@@ -0,0 +1,11 @@
+This file is closed before it is copied.
+
+If the copied file is a symbolic link (symlink), the
+file it refers to is copied, not the link itself. With the
+exception of permissions, which are copied, no other file metadata
+is copied.
+
+Returns \c true if successful; otherwise returns \c false.
+
+Note that if a file with the name \a newName already exists,
+copy() returns \c false. This means QFile will not overwrite it.
diff --git a/src/corelib/io/qfile.cpp b/src/corelib/io/qfile.cpp
index 07b40527cb..e031e9c091 100644
--- a/src/corelib/io/qfile.cpp
+++ b/src/corelib/io/qfile.cpp
@@ -755,13 +755,9 @@ QFile::link(const QString &fileName, const QString &linkName)
}
/*!
- Copies the file currently specified by fileName() to a file called
- \a newName. Returns \c true if successful; otherwise returns \c false.
+ Copies the file named fileName() to \a newName.
- Note that if a file with the name \a newName already exists,
- copy() returns \c false (i.e. QFile will not overwrite it).
-
- The source file is closed before it is copied.
+ \include qfile-copy.qdocinc
\sa setFileName()
*/
@@ -867,11 +863,9 @@ QFile::copy(const QString &newName)
/*!
\overload
- Copies the file \a fileName to \a newName. Returns \c true if successful;
- otherwise returns \c false.
+ Copies the file named \a fileName to \a newName.
- If a file with the name \a newName already exists, copy() returns \c false
- (i.e., QFile will not overwrite it).
+ \include qfile-copy.qdocinc
\sa rename()
*/