Skip to content

Add XML documentation comments to FileVersionInfo from reference XML#124133

Draft
Copilot wants to merge 3 commits intomainfrom
copilot/add-xml-comments-to-runtime
Draft

Add XML documentation comments to FileVersionInfo from reference XML#124133
Copilot wants to merge 3 commits intomainfrom
copilot/add-xml-comments-to-runtime

Conversation

Copy link
Contributor

Copilot AI commented Feb 7, 2026

Description

Migrated XML documentation from FileVersionInfo.xml reference file to source code. All public members of FileVersionInfo now have complete inline documentation.

Changes

  • Added <returns> tags to 27 properties documenting return values and null/zero behavior when version info is missing
  • Added method documentation to GetVersionInfo: <param>, <exception>, and <returns> tags
  • Enhanced ToString documentation with multi-line <returns> listing all properties included in output
  • Fixed int property documentation: Correctly documents returning 0 instead of null for FileBuildPart, FilePrivatePart, ProductBuildPart, ProductMajorPart, ProductMinorPart, ProductPrivatePart

Example

Before:

/// <summary>
/// Gets the build number of the file.
/// </summary>
public int FileBuildPart { get { return _fileBuild; } }

After:

/// <summary>
/// Gets the build number of the file.
/// </summary>
/// <returns>A value representing the build number of the file or 0 (zero) if the file did not contain version information.</returns>
public int FileBuildPart { get { return _fileBuild; } }

Testing

  • Validated build succeeds with no warnings
  • StyleCop checks pass
  • No security vulnerabilities introduced
Original prompt

Take the XML documentation comments from the FileVersionInfo.xml files in this repo (dotnet-api-docs) and put them into the /// XML comments in the dotnet/runtime repo please. Remarks should be formatted as Markdown in the /// XML. If there's a conflict between the two versions of the docs (/// vs. the ECMAXML in this dotnet-api-docs repo), insert <<<<< style conflict markers.


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

Copilot AI and others added 2 commits February 7, 2026 23:28
…methods

Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
…rsion info

Co-authored-by: gewarren <24882762+gewarren@users.noreply.github.com>
@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Feb 7, 2026
Copilot AI changed the title [WIP] Add XML documentation comments from FileVersionInfo.xml Add XML documentation comments to FileVersionInfo from reference XML Feb 7, 2026
Copilot AI requested a review from gewarren February 7, 2026 23:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants