Add missing API documentation for Microsoft.Extensions.FileProvider#125445
Open
Add missing API documentation for Microsoft.Extensions.FileProvider#125445
Conversation
Co-authored-by: svick <287848+svick@users.noreply.github.com>
svick
reviewed
Mar 11, 2026
src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullChangeToken.cs
Outdated
Show resolved
Hide resolved
Member
|
cc: @carlossanlop, in case you're still interested |
svick
approved these changes
Mar 11, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates XML documentation across the Microsoft.Extensions.FileProviders.* implementations to use more consistent constructor phrasing and clearer parameter descriptions, and adds explicit parameterless constructors where documentation is now provided.
Changes:
- Standardize constructor XML docs to “Initializes a new instance of the … class …”.
- Clarify several parameter descriptions (e.g.,
filters,disposing, and callback/state parameters). - Add explicit parameterless constructors (with docs) for
NullFileProviderandNotFoundDirectoryContents.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingWildCardChangeToken.cs | Constructor XML doc phrasing standardized. |
| src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs | Constructor XML doc standardized; callback/state param docs updated. |
| src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs | Constructor/parameter XML docs clarified and standardized. |
| src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs | Constructor/parameter XML docs clarified and standardized. |
| src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.cs | Constructor XML doc phrasing standardized. |
| src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.cs | Constructor XML doc phrasing standardized. |
| src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.cs | Constructor/parameter XML docs clarified and standardized. |
| src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.cs | Constructor XML doc grammar adjusted and standardized. |
| src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.cs | Adds explicit parameterless constructor with XML docs. |
| src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.cs | Constructor XML doc phrasing standardized. |
| src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.cs | Adds explicit parameterless constructor with XML docs. |
src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs
Show resolved
Hide resolved
…geCallback Co-authored-by: svick <287848+svick@users.noreply.github.com>
svick
approved these changes
Mar 11, 2026
This was referenced Mar 11, 2026
Open
Co-authored-by: svick <287848+svick@users.noreply.github.com>
src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.cs
Outdated
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ActiveChangeCallbacksproperty summary (incorrectly said "always false")Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.