[Foundation] Improve documentation and remove redundant platform attributes in NSOrderedSet<TKey>. by rolfbjarne · Pull Request #24345 · dotnet/macios

rolfbjarne · 2025-12-01T22:49:41Z

Make 'AsSet' return a non-null value, because the native function is defined as such.
Removed four [SupportedOSPlatform] attributes (ios, maccatalyst, macos, tvos) that had no version numbers.
Removed all 'To be added.' XML comments.
Added comprehensive XML documentation for all public members including:
- All constructors with proper parameter descriptions
- Indexer property
- Methods (ToArray, Contains, IndexOf, FirstObject, LastObject, AsSet)
- Operators (+, -, ==, !=)
- Override methods (Equals, GetHashCode)
- IEnumerable implementation
Fixed XML comment formatting and whitespace.
Added 'see cref' attributes for type references.

Contributes towards #17285.

…ibutes in NSOrderedSet<TKey>. * Make 'AsSet' return a non-null value, because the native function is defined as such. * Removed four [SupportedOSPlatform] attributes (ios, maccatalyst, macos, tvos) that had no version numbers. * Removed all 'To be added.' XML comments. * Added comprehensive XML documentation for all public members including: - All constructors with proper parameter descriptions - Indexer property - Methods (ToArray, Contains, IndexOf, FirstObject, LastObject, AsSet) - Operators (+, -, ==, !=) - Override methods (Equals, GetHashCode) - IEnumerable implementation * Fixed XML comment formatting and whitespace. * Added 'see cref' attributes for type references. Contributes towards #17285.

Copilot

Pull request overview

This PR improves the documentation and nullable reference type correctness for NSOrderedSet<TKey> in the Foundation namespace. The changes address documentation deficiencies by replacing placeholder "To be added" comments with comprehensive XML documentation, and also improve type safety by making the AsSet() method return a non-nullable value to match the native API definition.

Key changes:

Added comprehensive XML documentation for all public members (constructors, indexer, methods, operators)
Made AsSet() return non-null NSSet<TKey> to match native API behavior
Removed unnecessary platform attributes without version numbers

Reviewed changes

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

File	Description
src/Foundation/NSOrderedSet_1.cs	Added complete XML documentation for all public members, removed redundant platform attributes, and made AsSet() return non-nullable NSSet with null-forgiving operator
tests/cecil-tests/Documentation.KnownFailures.txt	Removed entries for NSOrderedSet operators and indexer that are now properly documented

You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

…sorderedset-1

vs-mobiletools-engineering-service2 · 2025-12-03T08:52:14Z

✅ [CI Build #f723eae] Build passed (Build packages) ✅

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-03T09:18:42Z

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

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-03T09:19:40Z

✅ [CI Build #f723eae] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-03T09:32:19Z

💻 [CI Build #f723eae] Tests on macOS X64 - Mac Sonoma (14) passed 💻

✅ All tests on macOS X64 - Mac Sonoma (14) passed.

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-03T09:38:33Z

💻 [CI Build #f723eae] Tests on macOS M1 - Mac Monterey (12) passed 💻

✅ All tests on macOS M1 - Mac Monterey (12) passed.

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-03T09:38:42Z

💻 [CI Build #f723eae] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

✅ All tests on macOS arm64 - Mac Sequoia (15) passed.

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-03T09:39:48Z

💻 [CI Build #f723eae] Tests on macOS M1 - Mac Ventura (13) passed 💻

✅ All tests on macOS M1 - Mac Ventura (13) passed.

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-03T10:07:22Z

✅ API diff for current PR / commit

NET (empty diffs)

iOS: vsdrops gist ( No breaking changes )
tvOS: vsdrops gist ( No breaking changes )
MacCatalyst: vsdrops gist ( No breaking changes )
macOS: vsdrops gist ( No breaking changes )

✅ API diff vs stable

NET (empty diffs)

iOS: vsdrops gist ( No breaking changes )
tvOS: vsdrops gist ( No breaking changes )
MacCatalyst: vsdrops gist ( No breaking changes )
macOS: vsdrops gist ( No breaking changes )

ℹ️ Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-03T10:25:02Z

💻 [CI Build #f723eae] Tests on macOS arm64 - Mac Tahoe (26) passed 💻

✅ All tests on macOS arm64 - Mac Tahoe (26) passed.

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

vs-mobiletools-engineering-service2 · 2025-12-04T10:14:15Z

🚀 [CI Build #f723eae] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 130 tests passed 🎉

Tests counts

✅ 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. [attempt 2] Html Report (VSDrops) Download
✅ introspection: All 6 tests passed. Html Report (VSDrops) Download
✅ linker: All 44 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 11 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 15 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 12 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 11 tests passed. Html Report (VSDrops) Download
✅ msbuild: All 2 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

Pipeline on Agent
Hash: f723eaeb82a2fdaa1be5aaad85e67bfc54190c25 [PR build]

rolfbjarne enabled auto-merge (squash) December 1, 2025 22:49

rolfbjarne requested a review from Copilot December 1, 2025 22:49

Copilot started reviewing on behalf of rolfbjarne December 1, 2025 22:50 View session

Copilot finished reviewing on behalf of rolfbjarne December 1, 2025 22:52

Copilot AI reviewed Dec 1, 2025

View reviewed changes

This comment has been minimized.

Sign in to view

dalexsoto approved these changes Dec 2, 2025

View reviewed changes

This comment has been minimized.

Sign in to view

Merge remote-tracking branch 'origin/main' into dev/rolf/foundation-n…

f723eae

…sorderedset-1

This comment has been minimized.

Sign in to view

rolfbjarne merged commit 13b9f99 into main Dec 4, 2025
45 checks passed

rolfbjarne added the copilot label Feb 2, 2026

Conversation

rolfbjarne commented Dec 1, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Dec 3, 2025

✅ [CI Build #f723eae] Build passed (Build packages) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 3, 2025

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

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 3, 2025

✅ [CI Build #f723eae] Build passed (Build macOS tests) ✅

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 3, 2025

💻 [CI Build #f723eae] Tests on macOS X64 - Mac Sonoma (14) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 3, 2025

💻 [CI Build #f723eae] Tests on macOS M1 - Mac Monterey (12) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 3, 2025

💻 [CI Build #f723eae] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 3, 2025

💻 [CI Build #f723eae] Tests on macOS M1 - Mac Ventura (13) passed 💻

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 3, 2025

✅ API diff for current PR / commit

✅ API diff vs stable

ℹ️ Generator diff

Uh oh!

vs-mobiletools-engineering-service2 commented Dec 3, 2025

💻 [CI Build #f723eae] Tests on macOS arm64 - Mac Tahoe (26) passed 💻

Uh oh!

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Dec 4, 2025

🚀 [CI Build #f723eae] Test results 🚀

Test results

Tests counts

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants