Document ten AppKit enum types - #26535
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
There was a problem hiding this comment.
🟢 Approval recommended
The changes are documentation-only and the known-failures baseline updates align with the documented enums, with only a minor documentation wording suggestion noted.
Pull request overview
This PR improves API documentation quality for AppKit by replacing placeholder XML documentation with complete summaries for ten enum types (and their members) in src/AppKit/Enums.cs, and then removing the corresponding Cecil documentation known-failure entries so the doc tests reflect the new coverage.
Changes:
- Added XML
<summary>documentation for ten AppKit enum types and their values (replacing “To be added.” placeholders). - Removed the now-resolved type entries from
tests/cecil-tests/Documentation.KnownFailures.txtto keep the documentation baseline up to date.
File summaries
| File | Description |
|---|---|
| tests/cecil-tests/Documentation.KnownFailures.txt | Removes known-failure entries for the enum types now fully documented. |
| src/AppKit/Enums.cs | Adds/updates XML documentation for the specified AppKit enums and their members. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
This comment has been minimized.
This comment has been minimized.
✅ 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 |
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.
🚀 [CI Build #3d2e0c0] Test results 🚀Test results✅ All tests passed on VSTS: test results. 🎉 All 264 tests passed 🎉 Tests counts✅ assembly-processing: All 1 tests passed. [attempt 3] Html Report (VSDrops) Download macOS tests✅ Tests on macOS Sonoma (14): All 5 tests passed. [attempt 2] Html Report (VSDrops) Download Linux Build VerificationPipeline on Agent |
Add complete XML documentation for ten AppKit enum types and their members:
NSAccessibilityAnnotationPositionNSAccessibilityCustomRotorSearchDirectionNSAnimationEffectNSBorderTypeNSBrowserDropOperationNSCollectionElementCategoryNSCollectionUpdateActionNSCellTypeNSCollectionViewScrollDirectionNSColorTypeRemove the corresponding entries from the Cecil documentation known-failures baseline.
🤖 Pull request created by Copilot