Fill and review API documentation#179
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit db26459:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| SkiaSharpAPI/SkiaSharp/SKColor.xml | Details | ||
| SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml | Details | ||
| SkiaSharpAPI/HarfBuzzSharp/Tag.xml | ✅Succeeded |
SkiaSharpAPI/SkiaSharp/SKColor.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched]
SkiaSharp.SKColor's moniker skiasharp can't match any assembly.
SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched]
SkiaSharp.SKFourByteTag's moniker skiasharp can't match any assembly.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
Fills the 4 remaining
To be added.placeholders that surfaced after this run's stub regeneration, all on span-based overloads that mirror an existing string overload with fully-written docs.What was filled (3 files, 4 members)
SkiaSharpAPI/SkiaSharp/SKColor.xml—SKColor.Parse(ReadOnlySpan<char>)andSKColor.TryParse(ReadOnlySpan<char>, out SKColor)— mirrored thestringoverloads (same accepted formats, same return semantics).SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml—SKFourByteTag.Parse(ReadOnlySpan<char>)— mirrored thestringoverload (up-to-4 ASCII chars, right-padded with spaces, longer truncated).SkiaSharpAPI/HarfBuzzSharp/Tag.xml—Tag.Parse(ReadOnlySpan<char>)— mirrored the ISO 15924stringoverload.What was reviewed
references/reviewing.md). New prose is a direct restatement of the sibling string-overload docs already accepted in the repo, so no factual drift is introduced.dotnet cake --target=docs-format-docswas run before and after; second run reports0/5026 (0.0%)missing members and0 finding(s), 0 error(s)across 406 type files.Findings summary
Machine block:
No obsolete-member usage was introduced (no code examples added in this pass). Nothing deferred.
Fixed vs deferred