Skip to content

Document ten AppKit enum types - #26535

Merged
rolfbjarne merged 11 commits into
mainfrom
dev/rolf/xmldocs-051-batch
Sep 2, 2026
Merged

Document ten AppKit enum types#26535
rolfbjarne merged 11 commits into
mainfrom
dev/rolf/xmldocs-051-batch

Conversation

@rolfbjarne

Copy link
Copy Markdown
Member

Add complete XML documentation for ten AppKit enum types and their members:

  • NSAccessibilityAnnotationPosition
  • NSAccessibilityCustomRotorSearchDirection
  • NSAnimationEffect
  • NSBorderType
  • NSBrowserDropOperation
  • NSCollectionElementCategory
  • NSCollectionUpdateAction
  • NSCellType
  • NSCollectionViewScrollDirection
  • NSColorType

Remove the corresponding entries from the Cecil documentation known-failures baseline.

🤖 Pull request created by Copilot

rolfbjarne and others added 10 commits September 2, 2026 13:27
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
Copilot AI lite review requested due to automatic review settings September 2, 2026 11:35

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.

🟢 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.txt to 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

Comment thread src/AppKit/Enums.cs Outdated
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@rolfbjarne
rolfbjarne enabled auto-merge (squash) September 2, 2026 11:43
@rolfbjarne rolfbjarne added the ready-to-review This PR is ready to review/merge. label Sep 2, 2026
@vs-mobiletools-engineering-service2

This comment has been minimized.

@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: 3d2e0c0665e69b90d74f2b5d9a186d9b475a283f [PR build]

@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 #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
✅ 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 7 tests passed. Html Report (VSDrops) Download
✅ linker (iOS): All 31 tests passed. Html Report (VSDrops) Download
✅ linker (MacCatalyst): All 31 tests passed. Html Report (VSDrops) Download
✅ linker (macOS): All 21 tests passed. Html Report (VSDrops) Download
✅ linker (tvOS): All 31 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 25 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 25 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 20 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 25 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 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: 3d2e0c0665e69b90d74f2b5d9a186d9b475a283f [PR build]

@rolfbjarne
rolfbjarne merged commit 62ad0cb into main Sep 2, 2026
54 checks passed
@rolfbjarne
rolfbjarne deleted the dev/rolf/xmldocs-051-batch branch September 2, 2026 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

copilot ready-to-review This PR is ready to review/merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants