[docs] Improve XML docs for CNContactFetchRequest, CIImageInitializationOptions, CVTime, NSInputStream, GKBehavior, GKState, NLLanguageRecognizer, NEHotspotHelperOptions, SCNScene, SLComposeViewController - #26294
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>
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>
Fix param-before-summary ordering in NSInputStream, GKBehavior, NLLanguageRecognizer, NEHotspotHelperOptions, SCNScene, and CVTime. Also fix empty returns node and double period in CVTime. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
There was a problem hiding this comment.
Pull request overview
This PR updates XML documentation across several Apple-platform binding types to replace placeholder docs, remove empty nodes, and improve readability of generated API docs.
Changes:
- Replaces “To be added.” placeholders with more meaningful
<summary>/<param>text across multiple bindings. - Removes empty
<remarks>/<value>/<returns>nodes in several places and fixes a minor typo (“zero duration..” → “zero duration.”). - Adjusts/standardizes XML doc content around common helpers and convenience APIs.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Social/SLComposeViewController.cs | Updates parameter docs for FromService / IsAvailable. |
| src/SceneKit/SCNScene.cs | Cleans up docs for scene node helpers and enumerators. |
| src/NetworkExtension/NEHotspotHelperOptions.cs | Cleans up class/ctor/property docs and removes placeholder nodes. |
| src/NaturalLanguage/NLLanguageRecognizer.cs | Removes placeholder remarks and updates docs for language hypothesis API. |
| src/GameplayKit/GKState.cs | Replaces placeholder param docs for transition helper methods. |
| src/GameplayKit/GKBehavior.cs | Improves indexer parameter documentation. |
| src/Foundation/NSInputStream.cs | Improves docs around Read overloads and removes empty remarks. |
| src/CoreVideo/CVTime.cs | Fixes typos and refines docs for Equals and CoreVideo host time APIs. |
| src/CoreImage/CIImageInitializationOptions.cs | Cleans up docs for initialization options and metadata subclass constructors. |
| src/Contacts/CNContactFetchRequest.cs | Improves constructor parameter docs for keys-to-fetch overloads. |
Comments suppressed due to low confidence (2)
src/Social/SLComposeViewController.cs:27
- Same as above: the PR description calls out fixing XML doc tag ordering (summary before param), but this method still has before
. Reordering improves readability and matches the stated intent.
/// <param name="serviceKind">The service kind.</param>
/// <summary>Returns <see langword="true" /> if the application can send a request for the specified service type.</summary>
src/CoreVideo/CVTime.cs:132
- Same issue here: the summary currently just repeats the method name. Adding a short description and what the return value represents would make the docs actionable.
/// <summary>GetHostClockMinimumTimeDelta.</summary>
- Fix param-before-summary in SLComposeViewController - Improve NLLanguageRecognizer.GetLanguageHypotheses summary and param - Improve NSInputStream.Read overload summary and param descriptions - Improve CVTime.GetCurrentHostTime summary Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
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.
This comment has been minimized.
This comment has been minimized.
Address review feedback: - Remove empty <value> and <returns> elements in CVTime - Fix indentation (normalize to single space after ///) - Fix param-before-summary ordering in all affected files - Fix extra whitespace in remarks elements - Improve placeholder summaries (GetHostClockMinimumTimeDelta) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 9a37ff16-2fda-4715-8343-f3408ac8c442
✅ 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 #5207f84] Test results 🚀Test results✅ All tests passed on VSTS: test results. 🎉 All 203 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 10 types:
Changes include adding missing summaries, fixing tag ordering (summary before param), removing empty nodes, and fixing typos.
🤖 Pull request created by Copilot