diff options
| author | Joerg Bornemann <joerg.bornemann@qt.io> | 2018-12-19 14:27:34 +0100 |
|---|---|---|
| committer | Joerg Bornemann <joerg.bornemann@qt.io> | 2018-12-20 13:10:15 +0000 |
| commit | 4f34d7e7ed6e9b58e40629045fc662e17c8623eb (patch) | |
| tree | 2893a307f4949b7e2776ae02bfee1bf345a462b1 /doc | |
| parent | 52a35195f083dae9f42059a6047daf7983b86e3b (diff) | |
Add FileInfo.canonicalPath
[ChangeLog] Added the canonicalPath() function to the FileInfo
extension.
Task-number: QBS-742
Change-Id: I8490b1bbdb3ac4ce84b80e82ca9f37bd2816e150
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/reference/jsextensions/jsextension-fileinfo.qdoc | 12 |
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 |