aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/jsextensions/jsextension-fileinfo.qdoc12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/reference/jsextensions/jsextension-fileinfo.qdoc b/doc/reference/jsextensions/jsextension-fileinfo.qdoc
index 8e847a5ef..967606ea7 100644
--- a/doc/reference/jsextensions/jsextension-fileinfo.qdoc
+++ b/doc/reference/jsextensions/jsextension-fileinfo.qdoc
@@ -44,6 +44,18 @@
\endcode
Returns the file name of \c filePath up to (but not including) the first '.' character.
+ \section2 canonicalPath
+ \code
+ FileInfo.canonicalPath(filePath: string): string
+ \endcode
+ Returns a canonicalized \c filePath, i.e. an absolute path without symbolic
+ links or redundant "." or ".." elements.
+ On Windows, drive substitutions are also resolved.
+
+ It is recommended to use \c{canonicalPath} in only those cases where
+ canonical paths are really necessary. In most cases, \c{cleanPath} should
+ be enough.
+
\section2 cleanPath
\code
FileInfo.cleanPath(filePath: string): string