Fill and review API documentation#177
Conversation
Grammar and style fixes across API docs identified during the reviewing pass: - SKPaint (type remarks): 'an paint' -> 'a paint' (2x). - SKStream (Move overload summaries): 'an relative offset' -> 'a relative offset' (2x). - SKCanvas (DrawAnnotation): 'Send an key/value pair' -> 'Sends a key/value pair'; 'on may canvas types' -> 'on many canvas types'. - SKFontManager (MatchCharacter remarks, 6 overloads): 'and3166-1' -> 'and 3166-1'; 'just pass a ISO 639 here' -> 'just pass an ISO 639 here'. - SKSurface (DisposeManaged): align summary with the standard SKNativeObject.DisposeManaged wording used in sibling types. Verified with: dotnet cake --target=docs-format-docs (0 findings, 0 errors on 430 types / 5022 members). 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 09f6297:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| SkiaSharpAPI/SkiaSharp/SKCanvas.xml | Details | ||
| SkiaSharpAPI/SkiaSharp/SKFontManager.xml | Details | ||
| SkiaSharpAPI/SkiaSharp/SKPaint.xml | Details | ||
| SkiaSharpAPI/SkiaSharp/SKStream.xml | Details | ||
| SkiaSharpAPI/SkiaSharp/SKSurface.xml | Details |
SkiaSharpAPI/SkiaSharp/SKCanvas.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched]
SkiaSharp.SKCanvas's moniker skiasharp can't match any assembly.
SkiaSharpAPI/SkiaSharp/SKFontManager.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched]
SkiaSharp.SKFontManager's moniker skiasharp can't match any assembly.
SkiaSharpAPI/SkiaSharp/SKPaint.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched]
SkiaSharp.SKPaint's moniker skiasharp can't match any assembly.
SkiaSharpAPI/SkiaSharp/SKStream.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched]
SkiaSharp.SKStream's moniker skiasharp can't match any assembly.
SkiaSharpAPI/SkiaSharp/SKSurface.xml
- Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched]
SkiaSharp.SKSurface'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 daily API docs writer/reviewer run.
Filled
No
To be added.placeholders remained anywhere underSkiaSharpAPI/— every documented member was already filled in a previous run. 0 files filled.Eight newly listed member entries in
index.xml(from a 4.150.0.0 → 4.151.0.0 assembly sync) were also verified against source and already had complete, correct docs:SkiaSharp.SKColorFilter.CreateOverdraw(SKColor[])SkiaSharp.SKColorFilter.CreateOverdraw(ReadOnlySpan<SKColor>)SkiaSharp.SKImageFilter.CreateCrop(SKRect)SkiaSharp.SKImageFilter.CreateCrop(SKRect, SKShaderTileMode)SkiaSharp.SKImageFilter.CreateCrop(SKRect, SKShaderTileMode, SKImageFilter?)SkiaSharp.SKImageFilter.CreateEmpty()SkiaSharp.SKPaint.GetFastBounds(SKRect, out SKRect)SkiaSharp.SKSurface.DisposeManaged()Reviewed
Deterministic gate ran clean on the full API surface — no missing docs, no lint findings, no XML errors:
On top of that, I ran the three correctness reviewers from
references/reviewing.md:skiasharp/binding/SkiaSharp/{SKColorFilter,SKImageFilter,SKPaint,SKSurface}.cs. Exception documentation (e.g.ArgumentNullExceptiononCreateOverdraw(SKColor[])) matches the source guard clauses; parameter/return semantics align with the native Skia contracts.<code>blocks for obsolete-member usage perreferences/obsolete-api-map.md. Only 4DrawTextexample calls exist across the tree; all use the modern(text, x, y, SKTextAlign, font, paint)signature. No obsoleteSKPaint.TextSize/Typeface/TextEncoding/TextAlign/...accessors, no old-signatureDrawText(text, x, y, paint), no obsolete constructors.SKPaint,SKCanvas,SKStream,SKFontManager,SKSurface) for the article/verb-tense/spelling patterns the deterministic linter cannot catch (domain-specific misuses ofan/a, verb-tense mismatches, single-letter typos inside otherwise-real English words).Findings summary
Fixed
All 10 MINOR quality findings above were fixed. Edits touch only
<Docs>content; XML structure preserved (verified by re-running the deterministic gate with 0 errors).SkiaSharpAPI/SkiaSharp/SKPaint.xmlSkiaSharpAPI/SkiaSharp/SKStream.xmlMove(int)andMove(long)summaries: "an relative offset" → "a relative offset".SkiaSharpAPI/SkiaSharp/SKCanvas.xmlDrawAnnotationsummary: "Send an key/value pair" → "Sends a key/value pair"; remarks CDATA: "on may canvas types" → "on many canvas types".SkiaSharpAPI/SkiaSharp/SKFontManager.xmlMatchCharacterremarks (6 overloads): "and3166-1" → "and 3166-1"; "just pass a ISO 639 here" → "just pass an ISO 639 here".SkiaSharpAPI/SkiaSharp/SKSurface.xmlDisposeManagedsummary aligned with the standardSKNativeObject.DisposeManagedwording used in sibling types.Deferred
None.
Validation
Re-run after edits: 0 findings, 0 errors — no broken XML/CDATA, no regressions.