Skip to content

Conversation

@AaronRobinsonMSFT
Copy link
Member

Fixes #120504

@AaronRobinsonMSFT
Copy link
Member Author

@ericstj The JavaMarshal type is fully documented in JavaMarshal.CoreCLR.cs. What do I need to do to connect that with the documentation tool?

@AaronRobinsonMSFT AaronRobinsonMSFT marked this pull request as ready for review October 22, 2025 03:02
@Copilot Copilot AI review requested due to automatic review settings October 22, 2025 03:03
@AaronRobinsonMSFT
Copy link
Member Author

/cc @dotnet/interop-contrib

Copy link
Contributor

Copilot AI left a comment

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 adds XML documentation comments to three Java interop types in System.Private.CoreLib to improve API documentation clarity. The changes address issue #120504 by documenting the purpose and members of types used in Java-to-.NET cross-reference processing.

Key changes:

  • Added type-level documentation for StronglyConnectedComponent, MarkCrossReferencesArgs, and ComponentCrossReference
  • Added field-level documentation for all members of MarkCrossReferencesArgs

Reviewed Changes

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

File Description
StronglyConnectedComponent.cs Added type-level summary describing the struct's role in cross-reference processing
MarkCrossReferencesArgs.cs Added type-level summary and documentation for all four fields (ComponentCount, Components, CrossReferenceCount, CrossReferences)
ComponentCrossReference.cs Added type-level summary describing cross-references between component groups

@dotnet-policy-service
Copy link
Contributor

Tagging subscribers to this area: @dotnet/interop-contrib
See info in area-owners.md if you want to be subscribed.

@AaronRobinsonMSFT
Copy link
Member Author

/ba-g Unrelated failures for outerloop

@AaronRobinsonMSFT AaronRobinsonMSFT merged commit c04e15f into dotnet:main Oct 24, 2025
126 of 142 checks passed
@AaronRobinsonMSFT AaronRobinsonMSFT deleted the runtime120504 branch October 24, 2025 01:54
@ericstj
Copy link
Member

ericstj commented Oct 24, 2025

@ericstj The JavaMarshal type is fully documented in JavaMarshal.CoreCLR.cs. What do I need to do to connect that with the documentation tool?

I did this a few days back as part of an earlier pass at filling gaps. Was trying to leverage copilot to do it. #120670

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

System.Runtime.InteropServices.Java docs for .NET 10.0 APIs

4 participants