Skip to content

[docs] Improve XML docs for UIImage, UIView, and 11 other types - #26068

Merged
rolfbjarne merged 14 commits into
mainfrom
dev/rolf/xmldocs-023-batch
Jul 14, 2026
Merged

rolfbjarne merged 14 commits into
mainfrom
dev/rolf/xmldocs-023-batch

Conversation

@rolfbjarne

Copy link
Copy Markdown
Member

Improve XML documentation for 13 types (removing empty nodes, fixing summaries):

  • UIImage: Remove empty node
  • UIView: Fix summary
  • VTCompressionSession: Remove empty node
  • VTDecompressionSession: Fix summary
  • VNRequest: Fix summary
  • SecPolicy: Remove empty node, fix summary
  • RPBroadcastConfiguration: Remove empty nodes
  • HMActionSet: Remove empty nodes
  • CALayer: Remove empty node
  • CIColor: Remove empty nodes
  • MLDictionaryFeatureProvider: Remove empty nodes
  • MLMultiArrayConstraint: Remove empty nodes
  • NSUndoManager: Remove empty nodes

Total: 43 changed lines (15 insertions, 28 deletions)

🤖 Pull request created by Copilot

rolfbjarne and others added 13 commits July 14, 2026 10:18
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>
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>
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>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 14, 2026 08:18
@rolfbjarne
rolfbjarne requested a review from dalexsoto as a code owner July 14, 2026 08:18

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 updates in-source XML documentation across multiple Apple platform bindings to replace placeholder text (“To be added.”), remove empty XML nodes, and improve API descriptions so generated docs are more accurate and useful.

Changes:

  • Replace placeholder , , and docs with meaningful descriptions.
  • Remove empty/placeholder and other empty XML doc nodes.
  • Clarify documentation for selected APIs in Vision, VideoToolbox, UIKit, Security, ReplayKit, HomeKit, Foundation, CoreML, CoreImage, and CoreAnimation.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/Vision/VNRequest.cs Improves documentation for GetResults.
src/VideoToolbox/VTDecompressionSession.cs Improves documentation for the outputCallback parameter.
src/VideoToolbox/VTCompressionSession.cs Removes an empty/placeholder node from the type docs.
src/UIKit/UIView.cs Updates documentation for Capture.
src/UIKit/UIImage.cs Removes an empty/placeholder node from the SaveStatus delegate docs.
src/Security/Policy.cs Removes placeholder and improves GetTypeID return docs.
src/ReplayKit/RPBroadcastConfiguration.cs Replaces placeholder property docs with meaningful summary/value.
src/HomeKit/HMActionSet.cs Replaces placeholder property docs with meaningful summary/value.
src/Foundation/NSUndoManager.cs Improves property documentation.
src/CoreML/MLMultiArrayConstraint.cs Improves property documentation.
src/CoreML/MLDictionaryFeatureProvider.cs Improves indexer summary/value docs (including nullability behavior).
src/CoreImage/CIColor.cs Improves property summary/value docs.
src/CoreAnimation/CALayer.cs Improves property documentation.

Comment thread src/UIKit/UIView.cs Outdated
Comment thread src/Vision/VNRequest.cs Outdated
@rolfbjarne
rolfbjarne enabled auto-merge (squash) July 14, 2026 09:33
@vs-mobiletools-engineering-service2

This comment has been minimized.

@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: 30f27fe36173d16d317efbd2a67f3fea22b7ba26 [PR build]

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

🚀 [CI Build #30f27fe] 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. [attempt 2] Html Report (VSDrops) Download
✅ interdependent-binding-projects: All 4 tests passed. Html Report (VSDrops) Download
✅ introspection: All 4 tests passed. [attempt 2] 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: 30f27fe36173d16d317efbd2a67f3fea22b7ba26 [PR build]

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants