Skip to content

Commit 03f503f

Browse files
Add doc comments to new PathUtils members
1 parent eb9069d commit 03f503f

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/PowerShellEditorServices/Utility/PathUtils.cs

+14
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ internal static class PathUtils
3030
/// </summary>
3131
internal static readonly char AlternatePathSeparator = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? '/' : '\\';
3232

33+
/// <summary>
34+
/// The <see cref="StringComparison" /> value to be used when comparing paths. Will be
35+
/// <see cref="StringComparison.Ordinal" /> for case sensitive file systems and <see cref="StringComparison.OrdinalIgnoreCase" />
36+
/// in case insensitive file systems.
37+
/// </summary>
3338
internal static readonly StringComparison PathComparison = RuntimeInformation.IsOSPlatform(OSPlatform.Linux)
3439
? StringComparison.Ordinal
3540
: StringComparison.OrdinalIgnoreCase;
@@ -41,6 +46,15 @@ internal static class PathUtils
4146
/// <returns>The normalized path.</returns>
4247
public static string NormalizePathSeparators(string path) => string.IsNullOrWhiteSpace(path) ? path : path.Replace(AlternatePathSeparator, DefaultPathSeparator);
4348

49+
/// <summary>
50+
/// Determines whether two specified strings represent the same path.
51+
/// </summary>
52+
/// <param name="left">The first path to compare, or <see langword="null" />.</param>
53+
/// <param name="right">The second path to compare, or <see langword="null" />.</param>
54+
/// <returns>
55+
/// <see langword="true" /> if the value of <paramref name="left" /> represents the same
56+
/// path as the value of <paramref name="right" />; otherwise, <see langword="false" />.
57+
/// </returns>
4458
internal static bool IsPathEqual(string left, string right)
4559
{
4660
if (string.IsNullOrEmpty(left))

0 commit comments

Comments
 (0)