[docs] Improve XML docs for NSCell, CTBaselineClass, MTProfessionalVideoWorkflow, NEVpnManager, INSetCarLockStatusIntent, CMCustomBlockAllocator - #26342
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
There was a problem hiding this comment.
Pull request overview
This PR improves XML documentation across several bound Apple API types in src/ by replacing placeholder docs, correcting tag ordering, and cleaning up doc formatting/indentation so the generated API docs are more useful and consistent.
Changes:
- Replace placeholder
<summary>/<param>/<remarks>content with meaningful documentation across the touched types. - Remove empty/placeholder remarks and improve formatting/indentation where applicable.
- Add/adjust parameter descriptions to better reflect API intent.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/AppKit/NSCell.cs | Replaces placeholder docs for image-drawing helpers with meaningful summaries and parameter descriptions. |
| src/CoreMedia/CMCustomBlockAllocator.cs | Adds meaningful type/ctor summaries and cleans up Dispose remarks formatting. |
| src/CoreText/CTBaselineClass.cs | Removes placeholder remarks and adds summaries for CTBaselineFont members. |
| src/Intents/INSetCarLockStatusIntent.cs | Fixes doc tag ordering and replaces placeholder parameter descriptions. |
| src/MediaToolbox/MTProfessionalVideoWorkflow.cs | Replaces placeholder docs with meaningful summaries for the type and API entry point. |
| src/NetworkExtension/NEVpnManager.cs | Fixes doc tag ordering/removes placeholders and adds a concrete summary/param description for SetAuthorization. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
✅ API diff for current PR / commitNET (empty diffs)✅ API diff vs stableNET (empty diffs)ℹ️ Generator diffGenerator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes) Pipeline on Agent |
🚀 [CI Build #0d98863] Test results 🚀Test results✅ All tests passed on VSTS: test results. 🎉 All 203 tests passed 🎉 Tests counts✅ assembly-processing: All 1 tests passed. Html Report (VSDrops) Download macOS tests✅ Tests on macOS Monterey (12): All 5 tests passed. Html Report (VSDrops) Download Linux Build VerificationPipeline on Agent |
Improve XML documentation for 6 types:
🤖 Pull request created by Copilot