Skip to content

[AppKit] Document ten enum types - #26573

Open
rolfbjarne wants to merge 11 commits into
mainfrom
dev/rolf/xmldocs-058-batch
Open

[AppKit] Document ten enum types#26573
rolfbjarne wants to merge 11 commits into
mainfrom
dev/rolf/xmldocs-058-batch

Conversation

@rolfbjarne

Copy link
Copy Markdown
Member

Document ten AppKit enum types and all their members:

  • NSWindowBackingLocation
  • NSWindowDepth
  • NSStackViewVisibilityPriority
  • NSPrinterTableStatus
  • NSWorkspaceIconCreationOptions
  • NSTabState
  • NSSurfaceOrder
  • NSEventGestureAxis
  • NSEventSwipeTrackingOptions
  • NSFontCollectionVisibility

Remove the matching entries from the Cecil documentation known-failures list.

🤖 Pull request created by Copilot

rolfbjarne and others added 10 commits September 7, 2026 19:49
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 7, 2026 17:58

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 change is limited to documentation improvements and known-failure list cleanup, with no functional/runtime behavior changes.

Pull request overview

This PR improves the public API documentation for a set of AppKit enum types by replacing placeholder XML docs with real summaries, and then removes the corresponding type entries from the Cecil documentation known-failures list (since they should no longer fail documentation validation).

Changes:

  • Added <summary> XML docs for 10 AppKit enum types and their members in src/AppKit/Enums.cs.
  • Removed the corresponding T:AppKit.* entries from tests/cecil-tests/Documentation.KnownFailures.txt.
File summaries
File Description
src/AppKit/Enums.cs Replaces placeholder enum/member docs with descriptive XML summaries for the 10 listed AppKit enums.
tests/cecil-tests/Documentation.KnownFailures.txt Removes known-failure type entries for the enums now documented.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 1
  • Review effort level: Lite

Comment thread src/AppKit/Enums.cs
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
@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: 516d5dca21916b706f2e14bb52010b51ec4f7ab0 [PR build]

@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 #516d5dc] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 264 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 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. [attempt 2] 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. 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: 516d5dca21916b706f2e14bb52010b51ec4f7ab0 [PR build]

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.

3 participants