Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 31, 2025

Ports documentation improvements for ObjectiveCMarshal.CreateReferenceTrackingHandle from dotnet/runtime#121232.

Changes

  • Replaced informal Initialize() reference with proper <xref> cross-reference to ObjectiveCMarshal.Initialize* method
  • Added explicit "parameter" qualifier to obj parameter mention for clarity

Modified File

xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal.xml

- The Initialize() must be called prior to calling this function.
+ The <xref:System.Runtime.InteropServices.ObjectiveC.ObjectiveCMarshal.Initialize*> function must be called prior to calling this function.

- The `obj` must have a type in its hierarchy marked with
+ The `obj` parameter must have a type in its hierarchy marked with
Original prompt

Please create PR that ports changes made in dotnet/runtime#121232 to this repo


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Updated ObjectiveCMarshal.CreateReferenceTrackingHandle documentation:
- Changed "The Initialize()" to use proper xref to Initialize method
- Changed "The `obj`" to "The `obj` parameter" for clarity

Co-authored-by: jkotas <[email protected]>
@jkotas jkotas marked this pull request as ready for review October 31, 2025 16:46
Copilot AI review requested due to automatic review settings October 31, 2025 16:46
@jkotas jkotas changed the title [WIP] Port changes from runtime PR 121232 to this repo Port changes from dotnet/runtime#121232 Oct 31, 2025
Copilot AI changed the title Port changes from dotnet/runtime#121232 Port documentation improvements from runtime PR #121232 Oct 31, 2025
Copilot AI requested a review from jkotas October 31, 2025 16:47
Copilot finished work on behalf of jkotas October 31, 2025 16:47
@jkotas jkotas changed the title Port documentation improvements from runtime PR #121232 Port documentation improvements from dotnet/runtime#121232 Oct 31, 2025
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 improves the documentation for the ObjectiveCMarshal class by clarifying parameter references and adding proper API cross-references. The changes enhance the readability and consistency of the XML documentation remarks.

  • Replaced informal reference "Initialize()" with proper <xref> link to the Initialize method
  • Changed "obj" to "obj parameter" for clearer parameter identification

@AaronRobinsonMSFT AaronRobinsonMSFT merged commit 3e82958 into main Oct 31, 2025
6 checks passed
@AaronRobinsonMSFT AaronRobinsonMSFT deleted the copilot/port-changes-from-runtime-pr-121232 branch October 31, 2025 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants