From aa418dc7d016048e30cc7cced93d25ebbf245dbb Mon Sep 17 00:00:00 2001 From: Joe Farebrother Date: Tue, 17 Oct 2023 12:51:22 +0100 Subject: [PATCH] Add more line breaks in qldoc --- shared/util/codeql/util/FilePath.qll | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/shared/util/codeql/util/FilePath.qll b/shared/util/codeql/util/FilePath.qll index feb99face42..1b047f3c91c 100644 --- a/shared/util/codeql/util/FilePath.qll +++ b/shared/util/codeql/util/FilePath.qll @@ -2,6 +2,7 @@ /** * A filepath that should be normalized. + * * Extend to provide additional strings that should be normalized as filepaths. */ abstract class NormalizableFilepath extends string { @@ -65,9 +66,13 @@ abstract class NormalizableFilepath extends 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. + * * The normalized path will be absolute (begin with `/`) if and only if the original path is. + * * The normalized path will not have a trailing `/`. + * * Only `/` is treated as a path separator. */ string getNormalizedPath() {