Repository navigation
[AppKit] Add XML docs for ten delegates - #26677
Conversation
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
There was a problem hiding this comment.
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
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. |
This comment has been minimized.
This comment has been minimized.
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.
This comment has been minimized.
This comment has been minimized.
π [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 macOS testsβ
Tests on macOS Sonoma (14): All 5 tests passed. Html Report (VSDrops) Download Linux Build VerificationPipeline on Agent |

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:
xml-doc-writerworkflow.π€ Pull request created by Copilot