Skip to content

[docs] Improve XML docs for NSCell, CTBaselineClass, MTProfessionalVideoWorkflow, NEVpnManager, INSetCarLockStatusIntent, CMCustomBlockAllocator - #26342

Merged
rolfbjarne merged 8 commits into
mainfrom
dev/rolf/xmldocs-039-batch
Jul 29, 2026
Merged

[docs] Improve XML docs for NSCell, CTBaselineClass, MTProfessionalVideoWorkflow, NEVpnManager, INSetCarLockStatusIntent, CMCustomBlockAllocator#26342
rolfbjarne merged 8 commits into
mainfrom
dev/rolf/xmldocs-039-batch

Conversation

@rolfbjarne

Copy link
Copy Markdown
Member

Improve XML documentation for 6 types:

Type Changes
NSCell Fix tag ordering, replace placeholder descriptions with meaningful docs
CTBaselineClass Remove empty remarks, add summaries for CTBaselineFont members
MTProfessionalVideoWorkflow Replace placeholder docs with meaningful summaries
NEVpnManager Fix tag ordering, replace placeholders, fix indentation
INSetCarLockStatusIntent Fix tag ordering, replace placeholder param descriptions
CMCustomBlockAllocator Replace placeholders, fix indentation, clean up remarks

🤖 Pull request created by Copilot

rolfbjarne and others added 7 commits July 29, 2026 14:56
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
Copilot AI review requested due to automatic review settings July 29, 2026 13:04
@rolfbjarne
rolfbjarne requested a review from dalexsoto as a code owner July 29, 2026 13:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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

Comment thread src/CoreText/CTBaselineClass.cs Outdated
@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
rolfbjarne enabled auto-merge (squash) July 29, 2026 17:58
@rolfbjarne rolfbjarne added the ready-to-review This PR is ready to review/merge. label Jul 29, 2026
@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

✅ API diff for current PR / commit

NET (empty diffs)

✅ API diff vs stable

NET (empty diffs)

ℹ️ Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent
Hash: 0d98863c15b27ab158baf836c20fbe539414ac0d [PR build]

@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

🚀 [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
✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (iOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (MacCatalyst): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (macOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (Multiple platforms): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (tvOS): All 1 tests passed. Html Report (VSDrops) Download
✅ framework: All 2 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 4 tests passed. Html Report (VSDrops) Download
✅ generator: All 5 tests passed. Html Report (VSDrops) Download
✅ interdependent-binding-projects: All 4 tests passed. Html Report (VSDrops) Download
✅ introspection: All 4 tests passed. Html Report (VSDrops) Download
✅ linker (iOS): All 15 tests passed. Html Report (VSDrops) Download
✅ linker (MacCatalyst): All 15 tests passed. Html Report (VSDrops) Download
✅ linker (macOS): All 21 tests passed. Html Report (VSDrops) Download
✅ linker (tvOS): All 15 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 19 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 18 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 19 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 19 tests passed. Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. Html Report (VSDrops) Download
✅ sharpie: All 1 tests passed. Html Report (VSDrops) Download
✅ windows: All 3 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 4 tests passed. Html Report (VSDrops) Download
✅ xtro: All 1 tests passed. Html Report (VSDrops) Download

macOS tests

✅ Tests on macOS Monterey (12): All 5 tests passed. Html Report (VSDrops) Download
✅ Tests on macOS Ventura (13): All 5 tests passed. Html Report (VSDrops) Download
✅ Tests on macOS Sonoma (14): All 5 tests passed. Html Report (VSDrops) Download
✅ Tests on macOS Sequoia (15): All 5 tests passed. Html Report (VSDrops) Download
✅ Tests on macOS Tahoe (26): All 5 tests passed. Html Report (VSDrops) Download

Linux Build Verification

Linux build succeeded

Pipeline on Agent
Hash: 0d98863c15b27ab158baf836c20fbe539414ac0d [PR build]

@rolfbjarne
rolfbjarne merged commit c44b15e into main Jul 29, 2026
56 checks passed
@rolfbjarne
rolfbjarne deleted the dev/rolf/xmldocs-039-batch branch July 29, 2026 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

copilot ready-to-review This PR is ready to review/merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants