diff options
Diffstat (limited to 'src/libs/utils/fileinprojectfinder.cpp')
| -rw-r--r-- | src/libs/utils/fileinprojectfinder.cpp | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/src/libs/utils/fileinprojectfinder.cpp b/src/libs/utils/fileinprojectfinder.cpp index 6ee3c34bec..957f694179 100644 --- a/src/libs/utils/fileinprojectfinder.cpp +++ b/src/libs/utils/fileinprojectfinder.cpp @@ -40,6 +40,7 @@ static bool checkPath(const FilePath &candidate, int matchLength, /*! \class Utils::FileInProjectFinder + \inmodule QtCreator \brief The FileInProjectFinder class is a helper class to find the \e original file in the project directory for a given file URL. @@ -109,13 +110,16 @@ void FileInProjectFinder::addMappedPath(const FilePath &localFilePath, const QSt } /*! - Returns the best match for the given file URL in the project directory. + Returns the best match for the file URL \a fileUrl in the project directory. The function first checks whether the file inside the project directory exists. If not, the leading directory in the path is stripped, and the - now shorter - path is checked for existence, and so on. Second, it tries to locate the file in the sysroot - folder specified. Third, we walk the list of project files, and search for a file name match - there. If all fails, it returns the original path from the file URL. + folder specified. Third, it walks the list of project files and searches for a file name match + there. + + If all fails, the function returns the original path from the file URL. To + indicate that no match was found in the project, \a success is set to false. */ FilePaths FileInProjectFinder::findFile(const QUrl &fileUrl, bool *success) const { |