Skip to content

[docs] Improve XML docs for PreserveAttribute, CLEnums, MKLocalSearch, and 12 more types - #26241

Merged
rolfbjarne merged 18 commits into
mainfrom
dev/rolf/xmldocs-030-batch
Jul 22, 2026
Merged

[docs] Improve XML docs for PreserveAttribute, CLEnums, MKLocalSearch, and 12 more types#26241
rolfbjarne merged 18 commits into
mainfrom
dev/rolf/xmldocs-030-batch

Conversation

@rolfbjarne

@rolfbjarne rolfbjarne commented Jul 22, 2026

Copy link
Copy Markdown
Member

Improve XML documentation for:

  • PreserveAttribute (Foundation)
  • CMSensorDataList (CoreMotion)
  • CSSearchableIndex (CoreSpotlight)
  • CLAuthorizationStatus and CLActivityType (CoreLocation)
  • CTFontCollection (CoreText)
  • GKGameModel (GameplayKit)
  • HMHome (HomeKit)
  • LAStatus (LocalAuthentication)
  • MKLocalSearch (MapKit)
  • CVPixelBufferAttributes (CoreVideo)
  • NSSound (AppKit)
  • NSSpeechSynthesizer (AppKit)
  • NSSpellChecker (AppKit)
  • AVCaptureDeviceInput (AVFoundation)
  • AVCaptureMetadataOutput (AVFoundation)

Changes:

  • Replace boilerplate 'To be added.' with meaningful descriptions
  • Remove empty XML doc nodes
  • Fix tag ordering (summary before param)
  • Fix indentation

🤖 Pull request created by Copilot

rolfbjarne and others added 17 commits July 22, 2026 18:02
@rolfbjarne
[docs] Improve XML docs for PreserveAttribute
c332234 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for CMSensorDataList
1a09572 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for CSSearchableIndex
fac1f57 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for CLAuthorizationStatus and CLActivityType
6e4d8da 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for CTFontCollection
c27ae6a 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for GKGameModel
b7fa79d 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for HMHome
08a5dec 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for LAStatus
32451a5 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for CVPixelBufferAttributes
e8212fc 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for NSSound
6e504b1 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for NSSpeechSynthesizer
5639742 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for NSSpellChecker
65c8ed2 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for AVCaptureDeviceInput
d6fce70 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for AVCaptureMetadataOutput
6b540e0 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for MKLocalSearch
06e2455 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Fix indentation in MKLocalSearch XML docs
a9d31e9 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
[docs] Fix XML doc tag ordering (summary before param)
c9a130c 
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 22, 2026 16:08
@rolfbjarne
rolfbjarne requested a review from dalexsoto as a code owner July 22, 2026 16:08
Copilot AI reviewed Jul 22, 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 updates XML documentation across several Apple framework bindings to replace placeholder text (“To be added.”), remove empty doc nodes, and fix XML tag ordering/indentation so IntelliSense is more useful and consistent.

Changes:

  • Replaced boilerplate/empty XML docs with more descriptive summaries, params, and return docs for a set of commonly used APIs.
  • Removed empty <remarks> / <returns> nodes and normalized documentation formatting (summary/param order, indentation).
  • Improved documentation for async/cancellation and nullable-return patterns in several APIs (with a couple of remaining mismatches noted in review comments).

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/MapKit/MKLocalSearch.cs Improves StartAsync XML docs (summary/param/returns/remarks).
src/LocalAuthentication/LAEnums.cs Adds meaningful enum value summaries for LAStatus.
src/HomeKit/HMHome.cs Documents GetServices summary/param/returns more clearly.
src/GameplayKit/GKGameModel.cs Removes empty/placeholder remarks from model constants/type.
src/Foundation/PreserveAttribute.cs Improves constructor summary/param docs.
src/CoreVideo/CVPixelBufferAttributes.cs Improves constructor docs and removes placeholder remarks.
src/CoreText/CTFontCollection.cs Removes placeholder remarks and improves ctor parameter documentation.
src/CoreSpotlight/CSSearchableIndex.cs Improves ctor summary/param docs for named indexes and protection options.
src/CoreMotion/CMSensorDataList.cs Removes placeholder returns/remarks from enumerator implementations.
src/CoreLocation/CLEnums.cs Improves enum value summaries for authorization/activity types.
src/AVFoundation/AVCaptureMetadataOutput.cs Refines property XML docs (metadata type filtering / available types).
src/AVFoundation/AVCaptureDeviceInput.cs Improves factory method summary/param/returns docs.
src/AppKit/NSSpellChecker.cs Adds meaningful docs for Language property.
src/AppKit/NSSpeechSynthesizer.cs Adds meaningful docs for Voice property.
src/AppKit/NSSound.cs Adds meaningful docs for Name property.

Comment thread src/MapKit/MKLocalSearch.cs
Comment thread src/AVFoundation/AVCaptureMetadataOutput.cs Outdated
Comment thread src/AVFoundation/AVCaptureMetadataOutput.cs Outdated
@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
@dalexsoto dalexsoto mentioned this pull request Jul 22, 2026
Closed
@rolfbjarne
[docs] Fix review comments: nullable return, metadata types wording
b9d80ec 
- MKLocalSearch.StartAsync: document nullable result on cancellation
- AVCaptureMetadataOutput: fix summaries to say 'metadata object types' not 'keys'

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
rolfbjarne enabled auto-merge (squash) July 22, 2026 17:59
@vs-mobiletools-engineering-service2

vs-mobiletools-engineering-service2 commented Jul 22, 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: b9d80ec9a451c1a331f6c2166b8521d040393eb3 [PR build]

@vs-mobiletools-engineering-service2

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

Copy link
Copy Markdown
Collaborator

🔥 [PR Build #c9a130c] Build failed (Build macOS tests) 🔥

Build failed for the job 'Build macOS tests' (with job status 'Canceled')

Pipeline on Agent
Hash: c9a130cfb73e8016ca64915ca5cade46f367f124 [PR build]

@vs-mobiletools-engineering-service2

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

Copy link
Copy Markdown
Collaborator

🚀 [CI Build #b9d80ec] 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: b9d80ec9a451c1a331f6c2166b8521d040393eb3 [PR build]

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

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@dalexsoto dalexsoto dalexsoto approved these changes

Assignees

No one assigned

Labels

copilot

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

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