[docs] Improve XML docs for HMCharacteristicMetadata, HMCharacteristicProperties, INCallRecord, INIntentResolutionResult, MTKTextureLoaderOptions, GKGridGraph, UIDynamicAnimator, UINavigationBar, CGDataConsumer, ModelNotImplementedException, GKEntity, GKPolygonObstacle, SCNRenderer, UIKitThreadAccessException - #26289
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>
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> 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 in src/ to replace placeholder docs, remove empty nodes, and normalize formatting so the generated API docs are more useful and consistent.
Changes:
- Removed placeholder
<remarks>,<returns>, and<value>nodes and replaced “To be added.” text with more descriptive summaries/params. - Adjusted XML doc layout/indentation in multiple files.
- Updated parameter documentation text for a number of members.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| src/UIKit/UINavigationBar.cs | Updates docs for UINavigationBarAppearance title text attribute accessors. |
| src/UIKit/UIDynamicAnimator.cs | Reorders/cleans up docs for behavior add/remove helpers and enumerators. |
| src/UIKit/UIApplication.cs | Updates docs for UIKitThreadAccessException and UIContentSizeCategoryChangedEventArgs. |
| src/SceneKit/SCNRenderer.cs | Replaces placeholder docs for OpenGL-context renderer factory. |
| src/MetalKit/MTKTextureLoaderOptions.cs | Cleans up property docs for texture loader option keys. |
| src/Intents/INIntentResolutionResult.cs | Cleans up docs for common resolution-result factory properties. |
| src/Intents/INCallRecord.cs | Removes placeholder <value>/<remarks> from call record properties. |
| src/HomeKit/HMCharacteristicProperties.cs | Cleans up property docs describing characteristic capabilities. |
| src/HomeKit/HMCharacteristicMetadata.cs | Cleans up docs for metadata unit/format accessors. |
| src/GameplayKit/GKPolygonObstacle.cs | Improves docs for point-based obstacle creation and ctor. |
| src/GameplayKit/GKGridGraph.cs | Improves docs for generic node lookup method. |
| src/GameplayKit/GKEntity.cs | Cleans up docs for component get/remove helpers. |
| src/Foundation/ModelNotImplementedException.cs | Cleans up exception type docs and constructor docs. |
| src/CoreGraphics/CGDataConsumer.cs | Cleans up docs for data-sink constructors (NSData/URL). |
Comments suppressed due to low confidence (4)
src/GameplayKit/GKEntity.cs:23
- The XML doc tag order is inverted here (param before summary) and the summary indentation is inconsistent. Reordering to summary-then-param will match standard C# XML doc formatting.
/// <param name="componentType">The component type.</param>
/// <summary>Retrieves the element in <see cref="GameplayKit.GKEntity.Components" /> of the specified <paramref name="componentType" />.</summary>
src/Intents/INIntentResolutionResult.cs:35
- This is a property, not a method. Referring to it as a "Factory method" in the summary is misleading in generated docs.
/// <summary>Factory method to create an <see cref="Intents.INIntentResolutionResult" /> object indicating that a value is not required for the parameter.</summary>
src/Intents/INIntentResolutionResult.cs:42
- This is a property, not a method. Referring to it as a "Factory method" in the summary is misleading in generated docs.
/// <summary>Factory method to create an <see cref="Intents.INIntentResolutionResult" /> object indicating that the developer's app does not support the parameter.</summary>
src/CoreGraphics/CGDataConsumer.cs:93
- The XML doc tag order is inverted here (param before summary) and URL should be capitalized consistently.
/// <param name="url">The url.</param>
/// <summary>Creates a data sink that saves the data on a file specified by the url.</summary>
- Fix UINavigationBar param-before-summary ordering - Fix MTKTextureLoaderOptions 'orable' typo - Fix HMCharacteristicProperties 'support bonjour' → 'supports Bonjour' - Fix ModelNotImplementedException grammar and summaries - Fix CGDataConsumer param-before-summary ordering - Fix GKEntity param-before-summary ordering - Fix GKGridGraph typeparam description - Fix INIntentResolutionResult 'Factory method' → property summaries - Fix UIKitThreadAccessException constructor summary - Fix UIContentSizeCategoryChangedEventArgs 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.
✅ 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.
🚀 [CI Build #e4aba3e] 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 |
Improves XML documentation for 14 types:
Changes:
<remarks>and<returns>nodes🤖 Pull request created by Copilot