feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

FilePath: fix documentation

Browse Source 
Change-Id: Icd2ea0842279ac5ca9225b760aa7634b8db3e06d
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
This commit is contained in:
Tim Jenssen
2023-01-27 17:58:57 +01:00
parent b8d0828d37
commit cc6c9e4b5e
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/libs/utils/filepath.cpp
View File

@@ -978,13 +978,13 @@ FilePath FilePath::relativeChildPath(const FilePath &parent) const
return res;
}
/// \returns the relativePath of FilePath from a given \a anchor.
/// \returns the relative path of FilePath from a given \a anchor.
/// Both, FilePath and anchor may be files or directories.
/// Example usage:
///
/// \code
/// FilePath filePath("/foo/b/ar/file.txt");
/// FilePath relativePath = filePath.relativePath("/foo/c");
/// FilePath relativePath = filePath.relativePathFrom("/foo/c");
/// qDebug() << relativePath
/// \endcode
///