[docs] Improve XML docs for NSLayoutManager and MLMultiArray - #26337
[docs] Improve XML docs for NSLayoutManager and MLMultiArray#26337rolfbjarne wants to merge 4 commits into
Conversation
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 MLMultiArray and NSLayoutManager. Normalize indentation in MLMultiArray Strides remarks. 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 improves XML documentation quality for existing bindings in UIKit and CoreML by reordering XML doc tags, removing placeholder elements, and normalizing indentation in remarks.
Changes:
- Reordered XML documentation tags so
<summary>appears before<param>and removed placeholder<remarks>/<value>entries. - Improved/standardized parameter documentation text for several APIs.
- Normalized indentation for the
MLMultiArray.Stridesremarks block.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/UIKit/NSLayoutManager.cs | Updates XML docs for GetGlyphs, ShowGlyphs, and GetLineFragmentInsertionPoints (tag ordering + parameter docs). |
| src/CoreML/MLMultiArray.cs | Updates XML docs for constructors/indexers, refines SetObject docs, and reformats Strides remarks. |
Comments suppressed due to low confidence (2)
src/CoreML/MLMultiArray.cs:102
- The sample code in the Strides remarks uses
new NSNumber[] { ... }for theshapeargument, but the only public constructor in this partial type takesnint[]. This example won't compile as written; update it to usenint[]and match the repo's spacing style.
/// NSError err;
/// var ma = new CoreML.MLMultiArray(new NSNumber[] { 3, 5, 7, 9 },CoreML.MLMultiArrayDataType.Int32, out err);
/// if (err is not null)
src/UIKit/NSLayoutManager.cs:100
- The
inDisplayOrderparameter description is ungrammatical ("The in display order.") and doesn't explain the boolean's effect.
/// <param name="inDisplayOrder">The in display order.</param>
- Add trailing periods to MLMultiArray param descriptions - Improve NSLayoutManager param docs to describe output buffers 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 #8881fd2] Test results 🔥Test results❌ Tests failed on VSTS: test results 1 tests crashed, 0 tests failed, 182 tests passed. Failures❌ linker tests (macOS)🔥 Failed catastrophically on VSTS: test results - linker_macos (no summary found). Html Report (VSDrops) Download Successes✅ 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:
///)🤖 Pull request created by Copilot