aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristian Kandeler <christian.kandeler@qt.io>2018-02-09 16:39:49 +0100
committerChristian Kandeler <christian.kandeler@qt.io>2018-02-12 09:15:05 +0000
commitcab08a9d17cdcbb6e39f9161845a3e275199386a (patch)
tree0b25f1fa7b1a5487c6f2784187a82ea456610c20
parent48e5b9d0c50db50f24b04a83a4e8163c531eea6d (diff)
Add documentation for FileInfo.{to,from}NativeSeparators
Task-number: QBS-1279 Change-Id: I9465777e9fa70394ed0ae6721f6fd368d2e49dfe Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--doc/reference/jsextensions/jsextension-fileinfo.qdoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/reference/jsextensions/jsextension-fileinfo.qdoc b/doc/reference/jsextensions/jsextension-fileinfo.qdoc
index d656ac8e8..8c0ac1ee0 100644
--- a/doc/reference/jsextensions/jsextension-fileinfo.qdoc
+++ b/doc/reference/jsextensions/jsextension-fileinfo.qdoc
@@ -64,6 +64,13 @@
Returns the last component of \c filePath, that is, everything after the
last '/' character.
+ \section2 fromNativeSeparators
+ \code
+ FileInfo.fromNativeSeparators(filePath: string): string
+ \endcode
+ On Windows hosts, this function behaves the same as \l fromWindowsSeparators. On other
+ operating systems, it returns the input unmodified.
+
\section2 fromWindowsSeparators
\code
FileInfo.fromWindowsSeparators(filePath: string): string
@@ -105,6 +112,13 @@
The function assumes \c dirPath and \c filePath to be absolute paths and \c dirPath to
be a directory.
+ \section2 toNativeSeparators
+ \code
+ FileInfo.toNativeSeparators(filePath: string): string
+ \endcode
+ On Windows hosts, this function behaves the same as \l toWindowsSeparators. On other
+ operating systems, it returns the input unmodified.
+
\section2 toWindowsSeparators
\code
FileInfo.toWindowsSeparators(filePath: string): string