Fill and review API documentation#178
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 3de5803:
|
| 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.
Automated api-docs pass.
Filled
Three new
ReadOnlySpan<char>overloads hadTo be added.placeholders after mdoc stub regeneration. Filled by mirroring the wording of the existingstringsibling overloads (accessor verbs and return semantics validated againstMemberSignature):SkiaSharpAPI/SkiaSharp/SKColor.xml—Parse(ReadOnlySpan<char>),TryParse(ReadOnlySpan<char>, out SKColor)SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml—Parse(ReadOnlySpan<char>)SkiaSharpAPI/HarfBuzzSharp/Tag.xml—Parse(ReadOnlySpan<char>)3 files · 4 members · summaries:4 params:5 returns:4 remarks:4
Reviewed
Reviewed the 3 touched files (source-first per the reviewing skill; sibling
stringoverloads treated as the authoritative reference for wording since ROS overloads forward to the same underlying parse). Deterministic lint (docs-format-docs) went fromDocumentation missing in 4/5026 membersto0/5026 members,0 findings, 0 errorsafter edits.Findings summary
Fixed vs deferred
To be added.placeholders.Validation
cd skiasharp && dotnet cake --target=docs-format-docs→ green (0 findings, 0 errors, 0/5026 missing).