Skip to content

[docs] Improve XML docs for NSScreen, NSTextField, AudioUnitUtils, and 7 more types - #26229

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

[docs] Improve XML docs for NSScreen, NSTextField, AudioUnitUtils, and 7 more types#26229
rolfbjarne merged 11 commits into
mainfrom
dev/rolf/xmldocs-029-batch

Conversation

@rolfbjarne

@rolfbjarne rolfbjarne commented Jul 22, 2026

Copy link
Copy Markdown
Member

Improve XML documentation for:

  • NSScreen (AppKit)
  • NSTextField (AppKit)
  • AudioUnitUtils (AudioUnit)
  • AudioRendererWasFlushedAutomaticallyEventArgs (AudioToolbox)
  • AVAudioFormat (AVFoundation)
  • PeripheralScanningOptions (CoreBluetooth)
  • ConnectAttribute (Foundation)
  • NSDimension (Foundation)
  • NSErrorException (Foundation)
  • NSUuid (Foundation)

Changes:

  • Replace boilerplate 'To be added.' with meaningful descriptions
  • Remove empty XML doc nodes
  • Fix formatting and indentation

🤖 Pull request created by Copilot

rolfbjarne and others added 10 commits July 22, 2026 09:40
@rolfbjarne
[docs] Improve XML docs for NSScreen
8bf430b 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for NSTextField
10b446d 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for AudioUnitUtils
34149ae 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for AudioRendererWasFlushedAutomaticallyEvent…
91e498b 
…Args

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for AVAudioFormat
386c3f5 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for PeripheralScanningOptions
943520c 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for ConnectAttribute
69120c3 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for NSDimension
7d4f224 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for NSErrorException
f36c9d6 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@rolfbjarne
[docs] Improve XML docs for NSUuid
879ff60 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 22, 2026 07:41
@rolfbjarne
rolfbjarne requested a review from dalexsoto as a code owner July 22, 2026 07:41
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 improves XML documentation across several Apple-platform binding types in src/, primarily by replacing placeholder “To be added.” text with meaningful summaries/values/returns and removing empty doc nodes to produce higher-quality generated API docs.

Changes:

  • Replaced boilerplate XML docs with concrete descriptions for properties/methods/consts across Foundation/AppKit/AVFoundation/AudioUnit/CoreBluetooth.
  • Removed empty <remarks> (and similar) nodes where they added no value.
  • Adjusted doc formatting/indentation in the touched areas.

Reviewed changes

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

Show a summary per file
File Description
src/Foundation/NSUuid.cs Improves GetBytes XML docs to describe returned 16-byte UUID representation.
src/Foundation/NSErrorException.cs Improves Message XML docs to clarify it comes from the underlying NSError.
src/Foundation/NSDimension.cs Improves BaseUnit docs (but wording should avoid “override” for a static member).
src/Foundation/ConnectAttribute.cs Removes empty <remarks> (but doc tag order/typo need fixing for valid XML docs).
src/CoreBluetooth/PeripheralScanningOptions.cs Documents AllowDuplicatesKey semantics for scanning duplicates.
src/AVFoundation/AVAudioFormat.cs Removes empty remarks and improves StreamDescription value docs.
src/AVFoundation/AudioRendererWasFlushedAutomaticallyEventArgs.cs Documents AudioRendererFlushTime meaning/value.
src/AudioUnit/AudioUnitUtils.cs Removes empty remarks and documents SampleFractionBits constant.
src/AppKit/NSTextField.cs Documents the typed Cell property override/hide.
src/AppKit/NSScreen.cs Documents SupportedWindowDepths property meaning and returned values.

Comment thread src/Foundation/ConnectAttribute.cs Outdated
Comment thread src/Foundation/NSDimension.cs Outdated
@rolfbjarne
rolfbjarne enabled auto-merge (squash) July 22, 2026 08:22
@rolfbjarne
[docs] Fix ConnectAttribute tag order/typo and NSDimension BaseUnit w…
3db63fe 
…ording

- Reorder param/summary tags and fix 'Inteface' -> 'Interface' typo
- Change 'override' to 're-declare' for static BaseUnit property

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

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: 3db63fe6efd7fa56a99150a6ae35a2e59d4bb4be [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
@dalexsoto dalexsoto mentioned this pull request Jul 22, 2026
Closed
@vs-mobiletools-engineering-service2

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

Copy link
Copy Markdown
Collaborator

🚀 [CI Build #3db63fe] 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. [attempt 2] 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: 3db63fe6efd7fa56a99150a6ae35a2e59d4bb4be [PR build]

@rolfbjarne
rolfbjarne merged commit 430319b into main Jul 22, 2026
56 checks passed
@rolfbjarne
rolfbjarne deleted the dev/rolf/xmldocs-029-batch branch July 22, 2026 15:51
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