[docs] Improve XML docs for SKError#25957
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the XML documentation for the StoreKit.SKError enum to replace placeholder summaries with meaningful descriptions, improving the quality of generated API docs for StoreKit error codes.
Changes:
- Replaced several
/// <summary>To be added.</summary>placeholders with descriptive summaries forSKErrorvalues. - (Per PR description) intended cleanup of empty XML doc nodes, though no
<remarks>nodes appear in the changed file.
| CloudServiceNetworkConnectionFailed, | ||
| // iOS 10.3 | ||
| /// <summary>To be added.</summary> | ||
| /// <summary>Indicates that the cloud service has been revoked.</summary> |
| /// <summary>Indicates that a privacy acknowledgement is required before proceeding.</summary> | ||
| PrivacyAcknowledgementRequired, | ||
| /// <summary>To be added.</summary> | ||
| /// <summary>Indicates that the request data is unauthorized.</summary> |
| /// <summary>Indicates that a privacy acknowledgement is required before proceeding.</summary> | ||
| PrivacyAcknowledgementRequired, |
This comment has been minimized.
This comment has been minimized.
✅ [PR Build #dc05dcd] Build passed (Detect API changes) ✅Pipeline on Agent |
✅ [PR Build #dc05dcd] Build passed (Build packages) ✅Pipeline on Agent |
✅ API diff for current PR / commitNET (empty diffs)✅ API diff vs stableNET (empty diffs)ℹ️ Generator diffGenerator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes) Pipeline on Agent |
✅ [PR Build #dc05dcd] Build passed (Build macOS tests) ✅Pipeline on Agent |
🚀 [CI Build #dc05dcd] Test results 🚀Test results✅ All tests passed on VSTS: test results. 🎉 All 199 tests passed 🎉 Tests counts✅ assembly-processing: All 1 tests passed. Html Report (VSDrops) Download macOS tests✅ Tests on macOS Monterey (12): All 5 tests passed. Html Report (VSDrops) Download Linux Build VerificationPipeline on Agent |
Improve XML documentation for the
SKErrorenum:<remarks>nodes🤖 Pull request created by Copilot