diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.cs b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.cs index 8b3110dd401dd3..410f0de4eaa39d 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.cs @@ -12,6 +12,11 @@ namespace Microsoft.Extensions.FileProviders /// public class NotFoundDirectoryContents : IDirectoryContents { + /// + /// Initializes a new instance of the class. + /// + public NotFoundDirectoryContents() { } + /// /// Gets a shared instance of . /// diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.cs b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.cs index 74cff98b1b14e0..ab1e79b8f95ba4 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.cs @@ -13,7 +13,7 @@ namespace Microsoft.Extensions.FileProviders public class NotFoundFileInfo : IFileInfo { /// - /// Initializes an instance of . + /// Initializes a new instance of the class. /// /// The name of the file that could not be found. public NotFoundFileInfo(string name) diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.cs b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.cs index 210ba67a140aa8..6a8eab52e440d1 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.cs @@ -10,6 +10,11 @@ namespace Microsoft.Extensions.FileProviders /// public class NullFileProvider : IFileProvider { + /// + /// Initializes a new instance of the class. + /// + public NullFileProvider() { } + /// /// Enumerates a nonexistent directory. /// diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.cs b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.cs index 7e66dc12d8d662..ce88caa1a79def 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.cs @@ -21,7 +21,7 @@ public class CompositeDirectoryContents : IDirectoryContents private List? _directories; /// - /// Creates a new instance of to represents the result of a call composition of + /// Initializes a new instance of the class to represent the result of a call composition of /// . /// /// The list of for which the results have to be composed. diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.cs index b8bb67eb4fa05c..42ebbe2abe66fd 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.cs @@ -17,7 +17,7 @@ public class PhysicalDirectoryContents : IDirectoryContents private readonly PhysicalDirectoryInfo _info; /// - /// Initializes an instance of . + /// Initializes a new instance of the class. /// /// The directory to represent. public PhysicalDirectoryContents(string directory) @@ -25,10 +25,10 @@ public PhysicalDirectoryContents(string directory) { } /// - /// Initializes an instance of . + /// Initializes a new instance of the class. /// /// The directory to represent. - /// Specifies which files or directories are excluded from enumeration. + /// A bitwise combination of the enumeration values that specifies which files or directories are excluded from enumeration. public PhysicalDirectoryContents(string directory, ExclusionFilters filters) { ArgumentNullException.ThrowIfNull(directory); diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.cs index ec1404564527fb..42e383ee63af78 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.cs @@ -20,7 +20,7 @@ public class PhysicalDirectoryInfo : IFileInfo, IDirectoryContents private readonly ExclusionFilters _filters; /// - /// Initializes an instance of that wraps an instance of . + /// Initializes a new instance of the class that wraps an instance of . /// /// The directory to represent. public PhysicalDirectoryInfo(DirectoryInfo info) diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.cs index ea70848d06fb3a..7a61206c00c0e9 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.cs @@ -14,7 +14,7 @@ public class PhysicalFileInfo : IFileInfo private readonly FileInfo _info; /// - /// Initializes an instance of that wraps an instance of . + /// Initializes a new instance of the class that wraps an instance of . /// /// The . public PhysicalFileInfo(FileInfo info) diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs index b9faf2ac1a9071..ede1b40f391a23 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs @@ -38,7 +38,7 @@ public class PhysicalFileProvider : IFileProvider, IDisposable private bool _disposed; /// - /// Initializes a new instance of a PhysicalFileProvider at the given root directory. + /// Initializes a new instance of the class at the given root directory. /// /// The root directory. This should be an absolute path. public PhysicalFileProvider(string root) @@ -47,10 +47,10 @@ public PhysicalFileProvider(string root) } /// - /// Initializes a new instance of a PhysicalFileProvider at the given root directory. + /// Initializes a new instance of the class at the given root directory. /// /// The root directory. This should be an absolute path. - /// Specifies which files or directories are excluded. + /// A bitwise combination of the enumeration values that specifies which files or directories are excluded. public PhysicalFileProvider(string root, ExclusionFilters filters) { if (!Path.IsPathRooted(root)) @@ -207,7 +207,7 @@ public void Dispose() /// /// Disposes the provider. /// - /// true is invoked from . + /// if invoked from ; otherwise, . protected virtual void Dispose(bool disposing) { if (!_disposed) diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs index c296bfabad95f7..64531c2eb7a0a8 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs @@ -41,14 +41,14 @@ public class PhysicalFilesWatcher : IDisposable private bool _disposed; /// - /// Initializes an instance of that watches files in . - /// Wraps an instance of . + /// Initializes a new instance of the class that watches files in . + /// Wraps an instance of . /// - /// Root directory for the watcher. - /// The wrapped watcher that's watching . + /// The root directory for the watcher. + /// The wrapped watcher that's watching . /// /// for the poller to use polling to trigger instances of - /// created by . + /// created by ; otherwise, . /// public PhysicalFilesWatcher( string root, @@ -59,16 +59,16 @@ public PhysicalFilesWatcher( } /// - /// Initializes an instance of that watches files in . - /// Wraps an instance of . + /// Initializes a new instance of the class that watches files in . + /// Wraps an instance of . /// - /// Root directory for the watcher. - /// The wrapped watcher that is watching . + /// The root directory for the watcher. + /// The wrapped watcher that is watching . /// /// for the poller to use polling to trigger instances of - /// created by . + /// created by ; otherwise, . /// - /// Specifies which files or directories are excluded. Notifications of changes to are not raised to these. + /// A bitwise combination of the enumeration values that specifies which files or directories are excluded. Notifications of changes to these are not raised. public PhysicalFilesWatcher( string root, FileSystemWatcher? fileSystemWatcher, @@ -247,7 +247,7 @@ public void Dispose() /// /// Disposes the provider. /// - /// true is invoked from . + /// if invoked from ; otherwise, . protected virtual void Dispose(bool disposing) { if (!_disposed) diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs index 0d6d020f4952f9..36877781d0c0d8 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs @@ -15,8 +15,10 @@ namespace Microsoft.Extensions.FileProviders.Physical /// /// /// Polling occurs every 4 seconds. - /// This change token does not raise any change callbacks. Callers should watch for to turn - /// from to and dispose the token after this happens. + /// By default, this change token does not raise change callbacks. Callers should watch for to turn + /// from to . + /// When is , callbacks registered via + /// will be invoked when the file changes. /// public class PollingFileChangeToken : IPollingChangeToken { @@ -28,8 +30,8 @@ public class PollingFileChangeToken : IPollingChangeToken private CancellationChangeToken? _changeToken; /// - /// Initializes a new instance of that polls the specified file for changes as - /// determined by . + /// Initializes a new instance of the class that polls the specified file for changes as + /// determined by . /// /// The to poll. public PollingFileChangeToken(FileInfo fileInfo) @@ -54,7 +56,8 @@ private DateTime GetLastWriteTimeUtc() } /// - /// Gets a value that's always . + /// Gets a value that indicates whether this token will proactively raise callbacks. If , the token + /// consumer must poll to detect changes. /// public bool ActiveChangeCallbacks { get; internal set; } @@ -108,10 +111,11 @@ public bool HasChanged } /// - /// Does not actually register callbacks. + /// Registers a callback that will be invoked when the token changes, if is . + /// If is , no callback is registered and an empty disposable is returned. /// - /// This parameter is ignored. - /// This parameter is ignored. + /// The callback to invoke. This parameter is ignored when is . + /// The state to pass to . This parameter is ignored when is . /// A disposable object that no-ops when disposed. public IDisposable RegisterChangeCallback(Action callback, object? state) { diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingWildCardChangeToken.cs b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingWildCardChangeToken.cs index 78f40d08a21a8b..63f768d89313a4 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingWildCardChangeToken.cs +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingWildCardChangeToken.cs @@ -34,7 +34,7 @@ public class PollingWildCardChangeToken : IPollingChangeToken private CancellationChangeToken? _changeToken; /// - /// Initializes a new instance of . + /// Initializes a new instance of the class. /// /// The root of the file system. /// The pattern to watch.