Fill and review API documentation#174
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
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 |
Contributor
|
Learn Build status updates of commit 41ac799: ✅ Validation status: passed
For more details, please refer to the build report. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
Daily two-pass
docs-format-docs+ reviewer sweep over the SkiaSharp API docs. The lint pass came up clean for the second day in a row, so this run is a reviewer-driven pass that targets a long-standing class of CRITICAL defects the deterministic linter cannot catch: obsolete-API usage in code examples (seereferences/obsolete-api-map.md).To be added.placeholders anywhere inSkiaSharpAPI/).docs-format-docs(0 findings), plus a manual reviewer-B sweep over every<![CDATA[ ... ```csharp ]]>example inSkiaSharpAPI/SkiaSharp/. 3 files needed CRITICAL fixes.Findings summary
Coverage gaps: none — every type file was scanned by the lint, every example block under
SkiaSharpAPI/SkiaSharp/was grep-audited for the obsolete-API patterns inobsolete-api-map.md§1 and §2.Assessment: Ready for release — both lint passes are green (0 findings, 0 errors) and the three CRITICAL examples now compile against the modern API.
CRITICAL
SkiaSharpAPI/SkiaSharp/SKPaint.xml·T:SkiaSharp.SKPaint— Type-level Simple Example used the obsoleteSKPaint.TextSize/TextScaleXproperties (compile-error obsolete perbinding/SkiaSharp/SKPaint.cs:377-415) and the obsoleteSKCanvas.DrawText(string, float, float, SKPaint)overload (binding/SkiaSharp/SKCanvas.cs:769). → Rewrote to createSKFont { Size = 64.0f }/SKFont { Size = 64.0f, ScaleX = 1.5f }and call the moderncanvas.DrawText(text, x, y, SKTextAlign.Left, font, paint)overload. Also addedusingto theSKPaintlocals so the example isIDisposable-correct.SkiaSharpAPI/SkiaSharp/SKCanvas.xml·T:SkiaSharp.SKCanvas(MemberGroupDrawText) — Example usedpaint.TextSize,paint.TextAlign,paint.TextScaleXand three calls to the obsoleteDrawText(string, float, float, SKPaint)overload. → Rewrote each of the three drawing blocks to allocate a per-blockusing var font = new SKFont { Size = 64.0f[, ScaleX = 1.5f] }and callcanvas.DrawText("Skia", x, y, SKTextAlign.{Left|Center|Right}, font, paint).SkiaSharpAPI/SkiaSharp/SKTypeface.xml·T:SkiaSharp.SKTypeface(MemberGroupFromFile) — Example usednew SKPaint { TextSize = 50, Typeface = tf }(both properties are compile-error obsolete onSKPaint) and the obsolete 4-argDrawTextoverload. → Rewrote withusing var font = new SKFont(tf, size: 50)andcanvas.DrawText("SkiaSharp", 50, 100, SKTextAlign.Left, font, paint). Addedusingto the typeface, font and paint locals.Machine-readable findings
Validation
dotnet cake --target=docs-format-docs(pass 1, before edits):Documentation missing in 0/430 (0.0%) types and 0/5022 (0.0%) members. Docs lint: scanned 406 type file(s), 0 finding(s), 0 error(s).dotnet cake --target=docs-format-docs(pass 2, after edits): same result —0 finding(s), 0 error(s). XML and CDATA remain well-formed.<Docs>content (CDATA-wrapped Markdown examples). No signatures, member declarations, or generated files were modified.SkiaSharpAPI/index.xml,SkiaSharpAPI/ns-*.xml,SkiaSharpAPI/_filter.xml,SkiaSharpAPI/FrameworksIndex/.