diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2021-06-23 09:33:10 +0200 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2021-06-23 20:09:46 +0200 |
| commit | cc2fdce35e6a958e021b4d4cdc0ace1a91b06d0c (patch) | |
| tree | 9aef672984f312d268ec196e1438e7d235221d50 /src/corelib/doc/src/includes | |
| parent | cbe65673b24bbe504223ee37511b298642415c81 (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/corelib/doc/src/includes')
| -rw-r--r-- | src/corelib/doc/src/includes/qfile-copy.qdocinc | 11 |
1 files changed, 11 insertions, 0 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. |