Improve the docs for ObjectiveCMarshal.CreateReferenceTrackingHandle slightly. #121232
Conversation
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
|
Tagging subscribers to this area: @dotnet/interop-contrib |
There was a problem hiding this comment.
Pull Request Overview
This PR improves documentation clarity in the ObjectiveCMarshal class by fixing XML documentation syntax and enhancing parameter descriptions.
- Updates the reference to
Initialize()to use proper XML documentation syntax (<cref>) - Clarifies the
objparameter description by explicitly referring to it as a "parameter"
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| ObjectiveCMarshal.cs | Updates XML documentation in CreateReferenceTrackingHandle method to use proper cref syntax and clarify parameter description |
| ObjectiveCMarshal.PlatformNotSupported.cs | Applies identical documentation updates to the platform-not-supported variant for consistency |
...es/System.Private.CoreLib/src/System/Runtime/InteropServices/ObjectiveC/ObjectiveCMarshal.cs
Show resolved
Hide resolved
...eLib/src/System/Runtime/InteropServices/ObjectiveC/ObjectiveCMarshal.PlatformNotSupported.cs
Show resolved
Hide resolved
AaronRobinsonMSFT
approved these changes
Oct 31, 2025
jkoritzinsky
approved these changes
Oct 31, 2025
|
/ba-g infrastructure timeouts |
Open
3 tasks
AaronRobinsonMSFT
pushed a commit
to dotnet/dotnet-api-docs
that referenced
this pull request
Oct 31, 2025
* Port documentation improvements from runtime PR #121232 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]> * Update xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal.xml * Update xml/System.Runtime.InteropServices.ObjectiveC/ObjectiveCMarshal.xml --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: jkotas <[email protected]> Co-authored-by: Jan Kotas <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
No description provided.