Skip to content

[AppKit] Add XML docs for ten delegates - #26677

Merged
rolfbjarne merged 15 commits into
mainfrom
dev/rolf/xmldocs-062
Sep 24, 2026
Merged

rolfbjarne merged 15 commits into
mainfrom
dev/rolf/xmldocs-062

Conversation

@rolfbjarne

Copy link
Copy Markdown
Member

Document ten active AppKit delegate types and remove their corresponding entries from the Cecil documentation known-failure baseline.

The batch covers application window enumeration and activity restoration, document completion and open-panel callbacks, event monitors, custom image drawing, and candidate-list formatting.

Validation:

  • Reviewed the modified XML documentation with the xml-doc-writer workflow.
  • Verified the delegate semantics against the installed AppKit SDK headers.
  • Verified every delegate parameter and return value is documented.
  • Verified all ten corresponding Cecil baseline entries were removed.
  • Verified the diff contains 25 additions and 10 deletions, within the 100-line batch limit.
  • The targeted Cecil test could not run locally because the repository .NET SDK is not installed; CI will provide executable coverage.

πŸ€– Pull request created by Copilot

Describe the enumerated window and the stop flag used to terminate application window enumeration.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Describe the restorable objects supplied when continuing a user activity.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Describe the native error pointer reported when an asynchronous document operation completes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Describe the event delivered to an AppKit global event monitor.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Describe how local event monitors return an event for dispatch or suppress it by returning null.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Describe the destination rectangle and success result for custom image drawing callbacks.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Describe the error supplied when an asynchronous document lock operation completes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Describe the URLs selected when the document controller's open panel completes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Describe the modal response reported by a document controller open panel.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Describe the candidate and index inputs and the attributed string returned for display.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Follow the repository XML documentation layout so the delegate documentation precedes its availability attribute.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Follow the repository XML documentation layout so the delegate documentation precedes its availability attribute.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Follow the repository XML documentation layout so the delegate documentation precedes its availability attribute.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
Clarify that the document controller supplies a null URL array when the user cancels the open panel, matching the AppKit header contract.

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 22, 2026 13:10

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.

Copilot review overview

🟑 Changes recommended

Three documented nullable callback values contradict non-nullable binding declarations until nullability annotations are added.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 Medium severity

Open (1)
What changed in this PR

Documents ten AppKit delegate types and removes their Cecil documentation baseline entries.

Changes:

  • Added XML documentation for delegate parameters and return values.
  • Removed ten corresponding known-failure entries.
File Description
src/​appkit.cs Adds documentation for ten AppKit delegates.
tests/​cecil-tests/​Documentation.KnownFailures.txt Removes resolved documentation failures.

Comment thread src/appkit.cs Resolved
@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

⚠️ AppSizeTest expected files changed ⚠️

The AppSizeTest detected changes in the expected app size files.

To update the expected files, add a comment with the following command:

/apply-gist https://gist.github.com/vs-mobiletools-engineering-service2/57299f17f82d96ac7c671dd055ddf451
Updated files
  • MacOSX-CoreCLR-R2R-size.txt

Pipeline on Agent
Hash: 95d84d25644bebb90b1612c023298cc90086e93e [PR build]

Copilot AI review requested due to automatic review settings September 23, 2026 14:18
@rolfbjarne
rolfbjarne enabled auto-merge (squash) September 23, 2026 14:20
@rolfbjarne rolfbjarne added the ready-to-review This PR is ready to review/merge. label Sep 23, 2026

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.

Copilot review overview

🟒 Approval recommended

The remaining documentation nit is non-blocking.

Review effort: Lite
Findings: None

Resolved since last review (1)

@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: c68e18446410437640b16187ba4b797ccc88b4c6 [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

This comment has been minimized.

@vs-mobiletools-engineering-service2

Copy link
Copy Markdown
Collaborator

πŸš€ [CI Build #c68e184] Test results πŸš€

Test results

βœ… All tests passed on VSTS: test results.

πŸŽ‰ All 269 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. [attempt 2] 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. [attempt 2] 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. [attempt 5] 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. 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
βœ… Tests on macOS Golden Gate (27): All 5 tests passed. Html Report (VSDrops) Download

Linux Build Verification

βœ… Linux build succeeded

Pipeline on Agent
Hash: c68e18446410437640b16187ba4b797ccc88b4c6 [PR build]

@rolfbjarne
rolfbjarne merged commit d8d90c6 into main Sep 24, 2026
56 checks passed
@rolfbjarne
rolfbjarne deleted the dev/rolf/xmldocs-062 branch September 24, 2026 18:54
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