[docs] Improve XML docs for CIVector, SCNText, UIDeviceOrientationExtensions, UISearchBar, and NSAttributedString - #26327
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>
…tch 037 Fix param-before-summary ordering in CIVector, SCNText, UISearchBar, UIDeviceOrientationExtensions, UIInterfaceOrientationExtensions, and NSAttributedString. Fix extra whitespace indentation. Remove empty returns/value elements. Improve placeholder summaries. 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 improve generated API docs quality by normalizing tag ordering/indentation and replacing placeholder text with meaningful summaries.
Changes:
- Reordered XML doc tags (placing
<summary>before<param>), normalized indentation, and removed empty<returns>/<value>elements. - Improved summaries for selected APIs (notably
CIVectorconstructors,SCNText.Create, and macOSNSAttributedString.GetAppKitAttributes).
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/UIKit/UISearchBar.cs | Refines XML docs for scope bar appearance helpers (but introduces two summary mismatches that should be corrected). |
| src/UIKit/UIEnumsExtensions.cs | Cleans up XML docs/tag ordering for orientation extension methods (type summary should say “enum/enumeration”, not “class”). |
| src/SceneKit/Constructors.cs | Replaces placeholder docs for SCNText.Create overloads with descriptive summaries/params. |
| src/Foundation/NSAttributedString.mac.cs | Improves summaries/params for GetAppKitAttributes overloads on macOS. |
| src/CoreImage/CIVector.cs | Improves constructor/method docs and removes empty <returns>/<remarks> blocks. |
Comments suppressed due to low confidence (1)
src/UIKit/UISearchBar.cs:56
- This method returns
TextAttributes, but the summary says it gets a "background image". This looks like a copy/paste mistake; update the summary to match the method name/return type (scope bar button title text attributes).
/// <summary>Gets the background image for the scope bar button for the specified state.</summary>
/// <param name="state">The state.</param>
public TextAttributes GetScopeBarButtonTitleTextAttributes (UIControlState state)
This comment has been minimized.
This comment has been minimized.
- Fix UISearchBar: summaries now say 'text attributes' not 'title' - Fix UIDeviceOrientationExtensions: say 'enumeration' not 'class' 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.
✅ 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 #175c1b8] 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 the following types:
Changes include:
///)<returns>and<value>elements🤖 Pull request created by Copilot