forked from qt-creator/qt-creator
FilePath: fix documentation
Change-Id: Icd2ea0842279ac5ca9225b760aa7634b8db3e06d Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
This commit is contained in:
@@ -978,13 +978,13 @@ FilePath FilePath::relativeChildPath(const FilePath &parent) const
|
|||||||
return res;
|
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.
|
/// Both, FilePath and anchor may be files or directories.
|
||||||
/// Example usage:
|
/// Example usage:
|
||||||
///
|
///
|
||||||
/// \code
|
/// \code
|
||||||
/// FilePath filePath("/foo/b/ar/file.txt");
|
/// FilePath filePath("/foo/b/ar/file.txt");
|
||||||
/// FilePath relativePath = filePath.relativePath("/foo/c");
|
/// FilePath relativePath = filePath.relativePathFrom("/foo/c");
|
||||||
/// qDebug() << relativePath
|
/// qDebug() << relativePath
|
||||||
/// \endcode
|
/// \endcode
|
||||||
///
|
///
|
||||||
|
Reference in New Issue
Block a user