Skip to content

[docs] Improve XML docs for MPVolumeSettings#25796

Merged
rolfbjarne merged 1 commit into
mainfrom
dev/rolf/xmldocs-008-mpvolumesettings
Jun 24, 2026
Merged

[docs] Improve XML docs for MPVolumeSettings#25796
rolfbjarne merged 1 commit into
mainfrom
dev/rolf/xmldocs-008-mpvolumesettings

Conversation

@rolfbjarne

Copy link
Copy Markdown
Member

Improve XML documentation for the MPVolumeSettings type:

  • Replace 'To be added.' placeholders with meaningful descriptions
  • Remove empty <remarks> nodes
  • Add proper documentation for AlertShow, AlertHide, and AlertIsVisible methods

🤖 Pull request created by Copilot

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 24, 2026 09:48

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

Improves the public XML documentation for MediaPlayer.MPVolumeSettings by replacing placeholder text with meaningful API descriptions and removing empty/placeholder remark blocks, making the generated docs more useful for consumers.

Changes:

  • Replaced “To be added.” placeholders with descriptive <summary> text for AlertShow and AlertHide.
  • Added proper <summary> and <returns> documentation for AlertIsVisible.
  • Removed empty/unhelpful <remarks> nodes.

@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

✅ [PR Build #a816d05] Build passed (Detect API changes) ✅

Pipeline on Agent
Hash: a816d054b3394aae3be36e911214395ee8aae86d [PR build]

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

✅ [PR Build #a816d05] Build passed (Build packages) ✅

Pipeline on Agent
Hash: a816d054b3394aae3be36e911214395ee8aae86d [PR build]

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

@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

✅ [PR Build #a816d05] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: a816d054b3394aae3be36e911214395ee8aae86d [PR build]

@rolfbjarne rolfbjarne enabled auto-merge (squash) June 24, 2026 10:33
@vs-mobiletools-engineering-service2

This comment has been minimized.

@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 #a816d05] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 207 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. [attempt 4] Html Report (VSDrops) Download
✅ linker (iOS): All 15 tests passed. [attempt 2] 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 20 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 19 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 20 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 20 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. [attempt 2] 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: a816d054b3394aae3be36e911214395ee8aae86d [PR build]

@rolfbjarne rolfbjarne merged commit 71aec46 into main Jun 24, 2026
57 checks passed
@rolfbjarne rolfbjarne deleted the dev/rolf/xmldocs-008-mpvolumesettings branch June 24, 2026 17:43
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