🔴 Live TV: dotnet/macios/pull/

rolfbjarne · 2026-07-31T15:04:43Z

Improve XML documentation for 23 types across multiple frameworks.

Types documented:
SCNJavaScript, SecIdentity, UINavigationController, UIPushBehavior, WebFrame, NWErrorDomain, AVCaptureFileOutput, AVUrlAssetOptions, ABAddressFormatting, BCChatButtonStyle, StartAdvertisingOptions, CVMetalTextureAttributes, CWConfiguration, EKUIBundle, NSBundle, INSetProfileInCarIntent, NWProtocolOptions, NEHotspotEapSettings, DelayedRegistrationAttribute, SKAction, UICollectionViewLayout, DCError, AVAssetDownloadStorageManagementPolicy

Changes:

Replace placeholder parameter descriptions with meaningful descriptions
Replace generic enum summaries with specific descriptions
Remove empty remarks elements
Fix tag ordering

🤖 Pull request created by Copilot

Improve XML documentation for SCNJavaScript, SecIdentity, UINavigationController, UIPushBehavior, WebFrame, NWErrorDomain, AVCaptureFileOutput, AVUrlAssetOptions, ABAddressFormatting, BCChatButtonStyle, StartAdvertisingOptions, CVMetalTextureAttributes, CWConfiguration, EKUIBundle, NSBundle, INSetProfileInCarIntent, NWProtocolOptions, NEHotspotEapSettings, DelayedRegistrationAttribute, SKAction, UICollectionViewLayout, DCError, and AVAssetDownloadStorageManagementPolicy. Changes include: - Replace placeholder parameter descriptions with meaningful descriptions - Replace generic enum summaries with specific descriptions - Remove empty remarks elements - Fix tag ordering Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442

Copilot

Pull request overview

Updates XML documentation across several Apple-framework binding types in dotnet/macios, primarily replacing placeholder docs and removing empty <remarks> blocks to improve generated API documentation/IntelliSense.

Changes:

Replace placeholder <param> documentation with more descriptive text for various APIs.
Improve some enum member summaries (and remove empty <remarks> tags).
Clean up XML doc structure by removing empty remarks elements.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/WebKit/WebKit.cs	Updates parameter XML docs for `WebFrame.LoadHtmlString`.
src/UIKit/UIPushBehavior.cs	Updates constructor parameter XML docs.
src/UIKit/UINavigationController.cs	Updates constructor parameter XML docs.
src/UIKit/UICollectionViewLayout.cs	Removes placeholder remarks and updates parameter docs.
src/SpriteKit/SKAction.cs	Updates parameter XML docs for `ResizeTo`.
src/Security/SecIdentity.cs	Removes placeholder `<remarks>` from type/property docs.
src/SceneKit/SCNJavaScript.cs	Removes placeholder `<remarks>` and improves parameter doc for `ExportModule`.
src/ObjCRuntime/DelayedRegistrationAttribute.cs	Removes placeholder `<remarks>` from attribute/type docs.
src/NetworkExtension/NEHotspotEapSettings.cs	Removes placeholder `<remarks>` from type/property docs.
src/Network/NWProtocolOptions.cs	Removes placeholder `<remarks>` from `ProtocolDefinition` docs.
src/network.cs	Improves enum member summaries for `NWErrorDomain`.
src/Intents/INSetProfileInCarIntent.cs	Improves constructor parameter XML docs.
src/Foundation/NSBundle.cs	Removes placeholder remarks and improves `PathsForResources` parameter doc.
src/EventKitUI/EKUIBundle.cs	Removes placeholder `<remarks>` from type/property docs.
src/devicecheck.cs	Improves some `DCError` enum member docs; removes placeholder remarks on `DCDevice.Supported`.
src/CoreWlan/CWConfiguration.cs	Removes placeholder `<remarks>` from type/property docs.
src/CoreVideo/CVMetalTextureAttributes.cs	Removes placeholder `<remarks>` from type/property docs.
src/CoreBluetooth/AdvertisementDataOptions.cs	Removes placeholder remarks and improves `StartAdvertisingOptions(NSDictionary)` parameter doc.
src/BusinessChat/Enums.cs	Improves enum member summaries for `BCChatButtonStyle` / `BCParameterName`.
src/AVFoundation/AVUrlAssetOptions.cs	Removes placeholder remarks and improves `AVUrlAssetOptions(NSDictionary)` parameter doc.
src/AVFoundation/AVCaptureFileOutput.cs	Improves parameter XML docs for `StartRecordingToOutputFile`.
src/AVFoundation/AVAssetDownloadStorageManagementPolicy.cs	Removes placeholder `<remarks>` from `Priority` property docs.
src/AddressBookUI/ABAddressFormatting.cs	Improves parameter XML docs for `ABAddressFormatting.ToString`.

Suppressed comments (1)

src/network.cs:18

🤖 💡 Documentation — Use standard acronym casing (DNS/TLS) in these summaries so they read well in generated docs and IntelliSense.

		/// <summary>Indicates dns.</summary>
		[Field ("kNWErrorDomainDNS")]
		Dns = 2,
		/// <summary>Indicates tls.</summary>
		[Field ("kNWErrorDomainTLS")]
		Tls = 3,

Replace generic parameter and summary descriptions with more specific, meaningful documentation that provides value in IntelliSense tooltips. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442

- ABAddressFormatting: Add summary and returns, reorder tags, fix indentation - AVAssetDownloadStorageManagementPolicy: Replace To be added summary/value with meaningful descriptions for both Priority properties Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442

Address review feedback: replace all 'To be added.' elements in every modified file with meaningful documentation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442

Sort XML documentation elements, fix indentation, and improve the remaining modified documentation blocks. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442

rolfbjarne · 2026-08-03T17:30:01Z

/azp run

azure-pipelines · 2026-08-03T17:30:35Z

Azure Pipelines: Successfully started running 3 pipeline(s).

vs-mobiletools-engineering-service2 · 2026-08-03T19:01:40Z

✅ API diff for current PR / commit

NET (empty diffs)

iOS: vsdrops gist ( No breaking changes )
tvOS: vsdrops gist ( No breaking changes )
MacCatalyst: vsdrops gist ( No breaking changes )
macOS: vsdrops gist ( No breaking changes )

✅ API diff vs stable

NET (empty diffs)

iOS: vsdrops gist ( No breaking changes )
tvOS: vsdrops gist ( No breaking changes )
MacCatalyst: vsdrops gist ( No breaking changes )
macOS: vsdrops gist ( No breaking changes )

ℹ️ Generator diff

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

Pipeline on Agent
Hash: d97396de11660c46503461cc61cc6aadc1c56dd4 [PR build]

vs-mobiletools-engineering-service2 · 2026-08-03T21:02:18Z

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

rolfbjarne requested a review from dalexsoto as a code owner July 31, 2026 15:04

Copilot AI review requested due to automatic review settings July 31, 2026 15:04

rolfbjarne added the copilot label Jul 31, 2026

Copilot started reviewing on behalf of rolfbjarne July 31, 2026 15:05

View session

Copilot AI reviewed Jul 31, 2026

View reviewed changes

Comment thread src/WebKit/WebKit.cs Resolved

Comment thread src/UIKit/UIPushBehavior.cs Resolved

Comment thread src/AddressBookUI/ABAddressFormatting.cs Resolved

Comment thread src/AVFoundation/AVCaptureFileOutput.cs Resolved

Comment thread src/network.cs Resolved

This comment has been minimized.

Sign in to view

rolfbjarne commented Aug 3, 2026

View reviewed changes

Comment thread src/AddressBookUI/ABAddressFormatting.cs Resolved

Comment thread src/AVFoundation/AVAssetDownloadStorageManagementPolicy.cs Resolved

rolfbjarne commented Aug 3, 2026

View reviewed changes

Comment thread src/AVFoundation/AVCaptureFileOutput.cs Resolved

This comment has been minimized.

Sign in to view

rolfbjarne and others added 2 commits August 3, 2026 14:39

[docs] Normalize XML documentation

d97396d

Sort XML documentation elements, fix indentation, and improve the remaining modified documentation blocks. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442

This comment has been minimized.

Sign in to view

rolfbjarne added the ready-to-review This PR is ready to review/merge. label Aug 3, 2026

rolfbjarne enabled auto-merge (squash) August 3, 2026 16:31

This was referenced Aug 3, 2026

[CI] Flaky: Mac Catalyst NativeAOT exits 133 in CGImageMetadataTest #26391

Open

[CI] Expired Apple development certificates break signing-dependent PR tests #26382

Closed

dalexsoto approved these changes Aug 3, 2026

View reviewed changes

rolfbjarne merged commit 97d65f4 into main Aug 3, 2026
56 checks passed

rolfbjarne deleted the dev/rolf/xmldocs-042-batch branch August 3, 2026 21:03

Conversation

rolfbjarne commented Jul 31, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

rolfbjarne commented Aug 3, 2026

Uh oh!

azure-pipelines Bot commented Aug 3, 2026

Uh oh!

vs-mobiletools-engineering-service2 commented Aug 3, 2026

✅ API diff for current PR / commit

✅ API diff vs stable

ℹ️ Generator diff

Uh oh!

vs-mobiletools-engineering-service2 commented Aug 3, 2026

🚀 [CI Build #d97396d] Test results 🚀

Test results

Tests counts

macOS tests

Linux Build Verification

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants