Skip to content

[docs] Improve XML docs for StoreProductParameters - #25759

Merged
rolfbjarne merged 1 commit into
mainfrom
dev/rolf/xmldocs-005-storeproductparameters
Jun 22, 2026
Merged

rolfbjarne merged 1 commit into
mainfrom
dev/rolf/xmldocs-005-storeproductparameters

Conversation

@rolfbjarne

Copy link
Copy Markdown
Member

Improve XML documentation for the StoreProductParameters type:

  • Replace "To be added." placeholder entries with meaningful descriptions
  • Improve text for AffiliateToken and CampaignToken properties
  • Remove empty nodes

🤖 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 22, 2026 10:39

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 the public XML documentation for StoreKit.StoreProductParameters by replacing placeholder docs with meaningful descriptions for the affiliate and campaign token properties.

Changes:

  • Updated text for AffiliateToken and CampaignToken to describe their purpose.
  • Replaced placeholder documentation with concrete nullability-aware descriptions.
  • Removed empty placeholder nodes.

@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

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

Pipeline on Agent
Hash: d53b71feb6d780f0f685bd158d8e0261a3c1098e [PR build]

@vs-mobiletools-engineering-service2

This comment has been minimized.

@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

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

Pipeline on Agent
Hash: d53b71feb6d780f0f685bd158d8e0261a3c1098e [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: d53b71feb6d780f0f685bd158d8e0261a3c1098e [PR build]

@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

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

Pipeline on Agent
Hash: d53b71feb6d780f0f685bd158d8e0261a3c1098e [PR build]

@rolfbjarne
rolfbjarne enabled auto-merge (squash) June 22, 2026 12:31
@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 #d53b71f] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 220 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 6 tests passed. [attempt 2] 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. Html Report (VSDrops) Download
✅ monotouch (iOS): All 21 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 24 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 24 tests passed. [attempt 4] Html Report (VSDrops) Download
✅ monotouch (tvOS): All 21 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. [attempt 2] 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. [attempt 2] 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: d53b71feb6d780f0f685bd158d8e0261a3c1098e [PR build]

@rolfbjarne
rolfbjarne merged commit a9c950a into main Jun 22, 2026
57 checks passed
@rolfbjarne
rolfbjarne deleted the dev/rolf/xmldocs-005-storeproductparameters branch June 22, 2026 18:46
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