Repository navigation
[docs] Improve XML docs for UIImage, UIView, and 11 other types - #26068
Conversation
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>
There was a problem hiding this comment.
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
,, anddocs 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. |
…etResults null cases
This comment has been minimized.
This comment has been minimized.
✅ 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 |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
🚀 [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 macOS tests✅ Tests on macOS Monterey (12): All 5 tests passed. Html Report (VSDrops) Download Linux Build VerificationPipeline on Agent |
Improve XML documentation for 13 types (removing empty nodes, fixing summaries):
nodenodenode, fix summarynodeTotal: 43 changed lines (15 insertions, 28 deletions)
🤖 Pull request created by Copilot