Skip to content

Add missing API documentation for Microsoft.Extensions.FileProvider - #125445

Merged
svick merged 6 commits into
mainfrom
copilot/add-api-documentation-fileprovider
Mar 17, 2026
Merged

Add missing API documentation for Microsoft.Extensions.FileProvider#125445
svick merged 6 commits into
mainfrom
copilot/add-api-documentation-fileprovider

Conversation

CopilotAI commented Mar 11, 2026

Copy link
Copy Markdown
Contributor
  • Fix ActiveChangeCallbacks property summary (incorrectly said "always false")
  • Fix class-level remarks (incorrectly said "does not raise any change callbacks")
Original prompt

This section details on the original issue you should resolve

<issue_title>API documentation debt - Microsoft.Extensions.FileProvider</issue_title>
<issue_description>Area owners: @maryamariyan@carlossanlop@jozkee

The APIs in the list below are missing some or all of their documentation. Please add the missing documentation directly in triple slash comments in source. We will make sure it gets ported to dotnet-api-docs after it's merged.

Make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki

Also please add me as a PR reviewer.

Community contributions are welcome.

Microsoft.Extensions.FileProviders
DocIdSummaryParametersTypeParametersReturnValueSource File PathDocs URL
Microsoft.Extensions.FileProviders.Physical namespaceMissingNANANAhttps://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.FileProviders.Physical.xmlhttps://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileProviders.Physical?branch=master
Microsoft.Extensions.FileProviders.Composite namespaceMissingNANANAhttps://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.FileProviders.Composite.xmlhttps://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileProviders.Composite?branch=master
Microsoft.Extensions.FileProviders namespaceMissingNANANAhttps://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.FileProviders.xmlhttps://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileProviders?branch=master
M:Microsoft.Extensions.FileProviders.NullFileProvider.#ctorMissingNANANAhttps://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileProviders/NullFileProvider.xmlhttps://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileProviders.NullFileProvider.-ctor?branch=master
M:Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.#ctorMissingNANANAhttps://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileProviders/NotFoundDirectoryContents.xmlhttps://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileProviders.NotFoundDirectoryContents.-ctor?branch=master
M:Microsoft.Extensions.FileProviders.FileSystemInfoHelper.#ctorMissingNANANAhttps://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileProviders/FileSystemInfoHelper.xmlhttps://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileProviders.FileSystemInfoHelper.-ctor?branch=master

Notes:

  • The namespaces need to be documented directly in dotnet-api-docs.
  • Some of the APIs are obsolete, so I'll let area owners decide if they want to still document them or skip them. If you opt for documenting them, please do it directly in dotnet-api-docs.</issue_description>

<agent_instructions>Add XML documentation for the members mentioned in the issue that still don't have it.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@ Tagging subscribers to this area: @maryamariyan See info in area-owners.md if you want to be subscribed.

💡 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.

Co-authored-by: svick <287848+svick@users.noreply.github.com>
@svick
svick marked this pull request as ready for review March 11, 2026 14:58
CopilotAI review requested due to automatic review settings March 11, 2026 14:58
@svick

Copy link
Copy Markdown
Member

cc: @carlossanlop, in case you're still interested

@svicksvick changed the title [WIP] Add missing API documentation for Microsoft.Extensions.FileProviderAdd missing API documentation for Microsoft.Extensions.FileProviderMar 11, 2026

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 NullFileProvider and NotFoundDirectoryContents.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingWildCardChangeToken.csConstructor XML doc phrasing standardized.
src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PollingFileChangeToken.csConstructor XML doc standardized; callback/state param docs updated.
src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.csConstructor/parameter XML docs clarified and standardized.
src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.csConstructor/parameter XML docs clarified and standardized.
src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileInfo.csConstructor XML doc phrasing standardized.
src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalDirectoryInfo.csConstructor XML doc phrasing standardized.
src/libraries/Microsoft.Extensions.FileProviders.Physical/src/Internal/PhysicalDirectoryContents.csConstructor/parameter XML docs clarified and standardized.
src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeDirectoryContents.csConstructor XML doc grammar adjusted and standardized.
src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NullFileProvider.csAdds explicit parameterless constructor with XML docs.
src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundFileInfo.csConstructor XML doc phrasing standardized.
src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/NotFoundDirectoryContents.csAdds explicit parameterless constructor with XML docs.

…geCallback
Co-authored-by: svick <287848+svick@users.noreply.github.com>
Co-authored-by: svick <287848+svick@users.noreply.github.com>
@svick
svick marked this pull request as ready for review March 12, 2026 12:32
CopilotAI review requested due to automatic review settings March 12, 2026 12:32

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.

@svick

Copy link
Copy Markdown
Member

/ba-g This is effectively a docs-only change, the failures shouldn't be related.

@svick
svick merged commit 8f7b6b5 into mainMar 17, 2026
86 of 90 checks passed
@svick
svick deleted the copilot/add-api-documentation-fileprovider branch March 17, 2026 15:15
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Apr 17, 2026
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API documentation debt - Microsoft.Extensions.FileProvider

4 participants

@svick@rosebyte