Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ namespace Microsoft.Extensions.FileSystemGlobbing.Abstractions
/// </summary>
public abstract class DirectoryInfoBase : FileSystemInfoBase
{
/// <summary>
/// Initializes a new instance of the <see cref="DirectoryInfoBase" /> class.
/// </summary>
protected DirectoryInfoBase() { }

/// <summary>
/// Enumerates all files and directories in the directory.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public class DirectoryInfoWrapper : DirectoryInfoBase
private readonly bool _isParentPath;

/// <summary>
/// Initializes an instance of <see cref="DirectoryInfoWrapper" />.
/// Initializes a new instance of the <see cref="DirectoryInfoWrapper" /> class.
/// </summary>
/// <param name="directoryInfo">The <see cref="DirectoryInfo" />.</param>
public DirectoryInfoWrapper(DirectoryInfo directoryInfo)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,9 @@ namespace Microsoft.Extensions.FileSystemGlobbing.Abstractions
/// </summary>
public abstract class FileInfoBase : FileSystemInfoBase
{
/// <summary>
/// Initializes a new instance of the <see cref="FileInfoBase" /> class.
/// </summary>
protected FileInfoBase() { }
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public class FileInfoWrapper : FileInfoBase
private readonly FileInfo _fileInfo;

/// <summary>
/// Initializes instance of <see cref="FileInfoWrapper" /> to wrap the specified object <see cref="System.IO.FileInfo" />.
/// Initializes a new instance of the <see cref="FileInfoWrapper" /> class to wrap the specified <see cref="System.IO.FileInfo" />.
/// </summary>
/// <param name="fileInfo">The <see cref="System.IO.FileInfo" /></param>
public FileInfoWrapper(FileInfo fileInfo)
Expand All @@ -36,7 +36,7 @@ public FileInfoWrapper(FileInfo fileInfo)
/// The full path of the file. (Overrides <see cref="FileSystemInfoBase.FullName" />).
/// </summary>
/// <remarks>
/// Equals the value of <see cref="System.IO.FileSystemInfo.Name" />.
/// Equals the value of <see cref="System.IO.FileSystemInfo.FullName" />.
/// </remarks>
public override string FullName => _fileInfo.FullName;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,22 @@ namespace Microsoft.Extensions.FileSystemGlobbing.Abstractions
public abstract class FileSystemInfoBase
{
/// <summary>
/// A string containing the name of the file or directory
/// Initializes a new instance of the <see cref="FileSystemInfoBase" /> class.
/// </summary>
protected FileSystemInfoBase() { }

/// <summary>
/// Gets the name of the file or directory.
/// </summary>
public abstract string Name { get; }

/// <summary>
/// A string containing the full path of the file or directory
/// Gets the full path of the file or directory.
/// </summary>
public abstract string FullName { get; }

/// <summary>
/// The parent directory for the current file or directory
/// Gets the parent directory for the current file or directory.
/// </summary>
public abstract DirectoryInfoBase? ParentDirectory { get; }
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public struct FilePatternMatch : IEquatable<FilePatternMatch>
public string Stem { get; }

/// <summary>
/// Initializes new instance of <see cref="FilePatternMatch" />
/// Initializes a new instance of the <see cref="FilePatternMatch" /> struct.
/// </summary>
/// <param name="path">The path to the file matched, relative to the beginning of the matching search pattern.</param>
/// <param name="stem">The subpath to the file matched, relative to the first wildcard in the matching search pattern.</param>
Expand Down Expand Up @@ -64,9 +64,9 @@ public override bool Equals([NotNullWhen(true)] object? obj) =>
obj is FilePatternMatch match && Equals(match);

/// <summary>
/// Gets a hash for the file pattern match.
/// Gets a hash code for the current <see cref="FilePatternMatch" />.
/// </summary>
/// <returns>Some number</returns>
/// <returns>A hash code for the current object.</returns>
public override int GetHashCode() =>
HashHelpers.Combine(GetHashCode(Path), GetHashCode(Stem));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public class InMemoryDirectoryInfo : DirectoryInfoBase
private readonly StringComparison _comparisonType;

/// <summary>
/// Creates a new case-sensitive InMemoryDirectoryInfo with the root directory and files given.
/// Initializes a new instance of the <see cref="InMemoryDirectoryInfo" /> class with the root directory and files given.
/// </summary>
/// <param name="rootDir">The root directory that this FileSystem will use.</param>
/// <param name="files">Collection of file names. If relative paths <paramref name="rootDir"/> will be prepended to the paths.</param>
Expand All @@ -30,7 +30,7 @@ public InMemoryDirectoryInfo(string rootDir, IEnumerable<string>? files)
}

/// <summary>
/// Creates a new InMemoryDirectoryInfo with the root directory and files given.
/// Initializes a new instance of the <see cref="InMemoryDirectoryInfo" /> class with the root directory and files given.
/// </summary>
/// <param name="rootDir">The root directory that this FileSystem will use.</param>
/// <param name="files">Collection of file names. If relative paths <paramref name="rootDir"/> will be prepended to the paths.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,15 @@ public class Matcher
internal StringComparison ComparisonType { get; }

/// <summary>
/// Initializes an instance of <see cref="Matcher" /> using case-insensitive matching
/// Initializes a new instance of the <see cref="Matcher" /> class using case-insensitive matching.
/// </summary>
public Matcher()
: this(StringComparison.OrdinalIgnoreCase, false)
{
}

/// <summary>
/// Initializes an instance of <see cref="Matcher" /> using the string comparison method specified
/// Initializes a new instance of the <see cref="Matcher" /> class using the string comparison method specified.
/// </summary>
/// <param name="comparisonType">The <see cref="StringComparison" /> to use</param>
public Matcher(StringComparison comparisonType)
Expand All @@ -122,7 +122,7 @@ public Matcher(StringComparison comparisonType)
}

/// <summary>
/// Initializes an instance of <see cref="Matcher" /> using the string comparison method and filter ordering specified
/// Initializes a new instance of the <see cref="Matcher" /> class using the string comparison method and filter ordering specified.
/// </summary>
/// <param name="comparisonType">The <see cref="StringComparison" /> to use</param>
/// <param name="preserveFilterOrder">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@

namespace Microsoft.Extensions.FileSystemGlobbing
{
/// <summary>
/// Provides extensions for configuring and executing a <see cref="Matcher" />.
/// </summary>
public static class MatcherExtensions
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ namespace Microsoft.Extensions.FileSystemGlobbing
public class PatternMatchingResult
{
/// <summary>
/// Initializes the result with a collection of <see cref="FilePatternMatch" />
/// Initializes a new instance of the <see cref="PatternMatchingResult" /> class with a collection of <see cref="FilePatternMatch" />.
/// </summary>
/// <param name="files">A collection of <see cref="FilePatternMatch" /></param>
public PatternMatchingResult(IEnumerable<FilePatternMatch> files)
Expand All @@ -23,7 +23,7 @@ public PatternMatchingResult(IEnumerable<FilePatternMatch> files)
}

/// <summary>
/// Initializes the result with a collection of <see cref="FilePatternMatch" />
/// Initializes a new instance of the <see cref="PatternMatchingResult" /> class with a collection of <see cref="FilePatternMatch" />.
/// </summary>
/// <param name="files">A collection of <see cref="FilePatternMatch" /></param>
/// <param name="hasMatches">A value that determines if <see cref="PatternMatchingResult"/> has any matches.</param>
Expand Down
Loading