Skip to content

[docs] Improve XML docs for AccountStoreOptions and AppKitThreadAccessException - #26132

Merged
rolfbjarne merged 3 commits into
mainfrom
dev/rolf/xmldocs-026-batch
Jul 16, 2026
Merged

[docs] Improve XML docs for AccountStoreOptions and AppKitThreadAccessException#26132
rolfbjarne merged 3 commits into
mainfrom
dev/rolf/xmldocs-026-batch

Conversation

@rolfbjarne

Copy link
Copy Markdown
Member

Improve XML documentation for:

  • AccountStoreOptions (Accounts framework)
  • AppKitThreadAccessException (AppKit)

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 2 commits July 16, 2026 15:28
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 16, 2026 13:29
@rolfbjarne
rolfbjarne requested a review from dalexsoto as a code owner July 16, 2026 13:29

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 API documentation in the macios bindings by replacing placeholder XML docs with actionable descriptions and by removing empty doc nodes.

Changes:

  • Updated XML documentation for AppKitThreadAccessException to describe when it’s thrown and what the constructor does.
  • Cleaned up XML docs in AccountStoreOptions (constructors, FacebookAppId, SetPermissions, TencentWeiboAppId) and removed empty <remarks>/<value> nodes.

Reviewed changes

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

File Description
src/AppKit/AppKitThreadAccessException.cs Replaces placeholder XML docs with a concrete exception description and constructor summary.
src/Accounts/AccountStoreOptions.cs Cleans up XML docs, improves parameter/value descriptions, and removes empty XML nodes.

Comment thread src/Accounts/AccountStoreOptions.cs Outdated
Comment thread src/Accounts/AccountStoreOptions.cs
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@rolfbjarne
rolfbjarne enabled auto-merge (squash) July 16, 2026 13:38
@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 #71a1f21] 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: 71a1f210abe5fae83c06325c3ed6b2dadf3722a0 [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: 71a1f210abe5fae83c06325c3ed6b2dadf3722a0 [PR build]

@rolfbjarne
rolfbjarne merged commit 21b4ea1 into main Jul 16, 2026
56 checks passed
@rolfbjarne
rolfbjarne deleted the dev/rolf/xmldocs-026-batch branch July 16, 2026 22:40
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