Skip to content

[docs] Improve XML docs for SCNGeometrySource, CVPixelBufferPool, INInteraction, GCExtendedGamepadSnapshotDataVersion, SCNMatrix4 - #26354

Merged
rolfbjarne merged 6 commits into
mainfrom
dev/rolf/xmldocs-040-batch
Jul 30, 2026
Merged

[docs] Improve XML docs for SCNGeometrySource, CVPixelBufferPool, INInteraction, GCExtendedGamepadSnapshotDataVersion, SCNMatrix4#26354
rolfbjarne merged 6 commits into
mainfrom
dev/rolf/xmldocs-040-batch

Conversation

@rolfbjarne

@rolfbjarne rolfbjarne commented Jul 29, 2026

Copy link
Copy Markdown
Member

Improve XML documentation for 5 types:

Type Changes
SCNGeometrySource Fix tag ordering/indentation, replace placeholders with docs
CVPixelBufferPool Remove empty value/remarks elements
INInteraction Fix tag ordering (summary before typeparam/param)
GCExtendedGamepadSnapshotDataVersion Replace placeholder summaries for enum values
SCNMatrix4 Fix tag ordering/indentation, add meaningful summary

🤖 Pull request created by Copilot

rolfbjarne and others added 5 commits July 29, 2026 22:19
@rolfbjarne
[docs] Improve XML docs for SCNGeometrySource
df49d89 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for CVPixelBufferPool
9a762fa 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for INInteraction
e91a2ba 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for GCExtendedGamepadSnapshotDataVersion
e14cf74 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for SCNMatrix4
3f78a2d 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 29, 2026 20:24
@rolfbjarne
rolfbjarne requested a review from dalexsoto as a code owner July 29, 2026 20:24
Copilot AI reviewed Jul 29, 2026
View reviewed changes

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 Apple framework binding types, primarily by replacing placeholder text, cleaning up empty XML elements, and standardizing doc comment structure to produce clearer API reference docs.

Changes:

  • Replaced placeholder XML docs with meaningful summaries/parameter descriptions (SceneKit + Intents + CoreVideo).
  • Removed empty <value> / <remarks> elements in CVPixelBufferPool to reduce noise.
  • Improved enum value summaries for snapshot data version enums in GameController.

Reviewed changes

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

Show a summary per file
File Description
src/SceneKit/SCNMatrix4_dotnet.cs Replaces placeholder constructor docs with a meaningful summary/param description for CATransform3D conversion.
src/SceneKit/SCNGeometrySource.cs Cleans up and clarifies factory method docs (summaries/params/remarks).
src/Intents/INInteraction.cs Reorders docs and replaces placeholders with meaningful typeparam/param/returns content.
src/GameController/Enums.cs Replaces placeholder enum value summaries with descriptive text for snapshot data versions.
src/CoreVideo/CVPixelBufferPool.cs Removes empty XML doc nodes and clarifies property/method documentation.

Comment thread src/GameController/Enums.cs Outdated
@rolfbjarne
Fix spacing in version enum summaries
abb4fb3 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@vs-mobiletools-engineering-service2

This comment has been minimized.

Sign in to view
@vs-mobiletools-engineering-service2

This comment has been minimized.

Sign in to view
@vs-mobiletools-engineering-service2

vs-mobiletools-engineering-service2 commented Jul 29, 2026

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: abb4fb3636f3cce5f1e7ab23824207d8b752bb42 [PR build]

@vs-mobiletools-engineering-service2

This comment has been minimized.

Sign in to view
@vs-mobiletools-engineering-service2

This comment has been minimized.

Sign in to view
@rolfbjarne
rolfbjarne enabled auto-merge (squash) July 30, 2026 06:35
@rolfbjarne rolfbjarne added the ready-to-review This PR is ready to review/merge. label Jul 30, 2026
@vs-mobiletools-engineering-service2

vs-mobiletools-engineering-service2 commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

🚀 [CI Build #abb4fb3] 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. [attempt 2] Html Report (VSDrops) Download
✅ monotouch (macOS): All 19 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 19 tests passed. [attempt 2] 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. [attempt 2] Html Report (VSDrops) Download

Linux Build Verification

✅ Linux build succeeded

Pipeline on Agent
Hash: abb4fb3636f3cce5f1e7ab23824207d8b752bb42 [PR build]

@rolfbjarne
rolfbjarne merged commit 7114f72 into main Jul 30, 2026
56 checks passed
@rolfbjarne
rolfbjarne deleted the dev/rolf/xmldocs-040-batch branch July 30, 2026 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments
@dalexsoto dalexsoto dalexsoto approved these changes

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@rolfbjarne @vs-mobiletools-engineering-service2 @dalexsoto