aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJake Petroules <jake.petroules@petroules.com>2015-08-07 14:07:57 -0700
committerJake Petroules <jake.petroules@petroules.com>2015-08-12 09:20:34 +0000
commitb4503f1cb832262f0740fb2fb168a09183328da1 (patch)
tree9ecd6afc59e29837473fcb398be2beb953dca2a5 /doc
parentbec7f134f0d5c65478fa50e2a9ac3355a0b60450 (diff)
File extension: add rename functionality.
Change-Id: Ia7356e283cad26efcd7b320077055f80545f4c64 Reviewed-by: Christian Kandeler <christian.kandeler@theqtcompany.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/jsextensions/jsextension-file.qdoc9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/reference/jsextensions/jsextension-file.qdoc b/doc/reference/jsextensions/jsextension-file.qdoc
index 1b692b4c2..0b40f30a8 100644
--- a/doc/reference/jsextensions/jsextension-file.qdoc
+++ b/doc/reference/jsextensions/jsextension-file.qdoc
@@ -80,6 +80,15 @@
Makes the directory at \c path, creating intermediate directories if necessary.
Conceptually equivalent to \c{mkdir -p}
+ \section2 move
+ \code
+ File.move(oldPath: string, newPath: string, overwrite: boolean = true): boolean
+ \endcode
+ Renames the file \c oldPath to \c newPath.
+ Returns \c true if successful; otherwise returns \c false.
+ If a file with the name \c newPath already exists, and \c overwrite is \c false,
+ \c move() returns \c false (that is, the file will not be overwritten).
+
\section2 remove
\code
File.remove(filePath: string): boolean