Backport XML docs for System.Diagnostics.FileVersionInfo from dotnet-api-docs#124405
Draft
Backport XML docs for System.Diagnostics.FileVersionInfo from dotnet-api-docs#124405
Conversation
…d docs Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Backport XML documentation for FileVersionInfo
Backport XML docs for System.Diagnostics.FileVersionInfo from dotnet-api-docs
Feb 13, 2026
gewarren
reviewed
Feb 13, 2026
Contributor
There was a problem hiding this comment.
@copilot Docs should never be added to the ref assembly.
Contributor
Author
There was a problem hiding this comment.
Removed the XML docs from the ref assembly in commit a640b63. Also restored UseCompilerGeneratedDocXmlFile=false in the csproj since enabling compiler-generated docs would require XML documentation in the generated platform-not-supported stubs, which would need to come from the ref assembly.
Contributor
There was a problem hiding this comment.
@richlander @jeffhandley Is Copilot correct that there needs to be docs in the ref assembly here?
Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
Contributor
|
Tagging subscribers to this area: @steveisok, @dotnet/area-system-diagnostics |
This was referenced Feb 14, 2026
Open
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.
Description
Backports XML documentation from dotnet-api-docs to the
System.Diagnostics.FileVersionInfosource implementation.Changes
FileVersionInfo.cs): Added<summary>,<value>,<param>, and<returns>tags to all public membersFileBuildPart,FilePrivatePart,Product*Part) to return0instead ofnullwhen version info is missing (original dotnet-api-docs XML had incorrect null references for value types)Note on Compiler-Generated Docs
This library keeps
<UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>in the project file because:GeneratePlatformNotSupportedAssemblyMessagewhich generates platform-not-supported stub filesExample
Properties now have complete inline documentation:
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.