[docs] Improve XML docs for ObjCException, NLLanguage, CFHTTPAuthentication, CFHTTPStream, EKParticipantType, EKErrorCode, EKWeekday - #25976
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Improves XML documentation across several Apple platform bindings to make public API docs more accurate and helpful for consumers.
Changes:
- Updated/expanded XML docs for
ObjCException,NLLanguage, and multiple EventKit enums to replace placeholder text with meaningful descriptions. - Removed empty
<remarks>blocks fromCFHTTPAuthenticationandCFHTTPStream. - Improved enum member summaries for
EKErrorCodeandEKWeekday.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/NaturalLanguage/Enums.cs | Updates NLLanguage.Unevaluated summary text. |
| src/Foundation/ObjCException.cs | Replaces placeholder XML docs with more descriptive summaries/param docs. |
| src/EventKit/EKEnums.cs | Improves enum member summaries for EKParticipantType, EKErrorCode, and EKWeekday. |
| src/CFNetwork/CFHTTPStream.cs | Removes empty XML <remarks> node. |
| src/CFNetwork/CFHTTPAuthentication.cs | Removes empty XML <remarks> node. |
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.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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 |
🚀 [CI Build #365088b] Test results 🚀Test results✅ All tests passed on VSTS: test results. 🎉 All 199 tests passed 🎉 Tests counts✅ assembly-processing: All 1 tests passed. Html Report (VSDrops) Download macOS tests✅ Tests on macOS Monterey (12): All 5 tests passed. Html Report (VSDrops) Download Linux Build VerificationPipeline on Agent |
Improve XML documentation for several types:
<remarks>node<remarks>nodeTotal: 46 changed lines (27 insertions, 19 deletions)
🤖 Pull request created by Copilot