From 4f34d7e7ed6e9b58e40629045fc662e17c8623eb Mon Sep 17 00:00:00 2001 From: Joerg Bornemann Date: Wed, 19 Dec 2018 14:27:34 +0100 Subject: Add FileInfo.canonicalPath [ChangeLog] Added the canonicalPath() function to the FileInfo extension. Task-number: QBS-742 Change-Id: I8490b1bbdb3ac4ce84b80e82ca9f37bd2816e150 Reviewed-by: Christian Kandeler --- doc/reference/jsextensions/jsextension-fileinfo.qdoc | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'doc') 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 -- cgit v1.2.3