hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-20 18:56:32 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add more line breaks in qldoc

Browse Source
This commit is contained in:
Joe Farebrother
2023-10-17 12:51:22 +01:00
parent 05162c68ec
commit aa418dc7d0
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
shared/util/codeql/util/FilePath.qll
View File

@@ -2,6 +2,7 @@
/** /**
* A filepath that should be normalized. * A filepath that should be normalized.
*
* Extend to provide additional strings that should be normalized as filepaths. * Extend to provide additional strings that should be normalized as filepaths.
*/ */
abstract class NormalizableFilepath extends string { abstract class NormalizableFilepath extends string {
@@ -65,9 +66,13 @@ abstract class NormalizableFilepath extends string {
/** /**
* Gets the normalized filepath for this string. * Gets the normalized filepath for this string.
*
* Normalizes `..` paths, `.` paths, and multiple `/`s as much as possible, but does not normalize case, resolve symlinks, or make relative paths absolute. * Normalizes `..` paths, `.` paths, and multiple `/`s as much as possible, but does not normalize case, resolve symlinks, or make relative paths absolute.
*
* The normalized path will be absolute (begin with `/`) if and only if the original path is. * The normalized path will be absolute (begin with `/`) if and only if the original path is.
*
* The normalized path will not have a trailing `/`. * The normalized path will not have a trailing `/`.
*
* Only `/` is treated as a path separator. * Only `/` is treated as a path separator.
*/ */
string getNormalizedPath() { string getNormalizedPath() {