Skip to content

Fill and review API documentation#177

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
automation/write-api-docs
Open

Fill and review API documentation#177
github-actions[bot] wants to merge 1 commit into
mainfrom
automation/write-api-docs

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Automated daily API docs writer/reviewer run.

Filled

No To be added. placeholders remained anywhere under SkiaSharpAPI/ — 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:

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).

On top of that, I ran the three correctness reviewers from references/reviewing.md:

  • A. Factual — verified all 8 new-member docs against skiasharp/binding/SkiaSharp/{SKColorFilter,SKImageFilter,SKPaint,SKSurface}.cs. Exception documentation (e.g. ArgumentNullException on CreateOverdraw(SKColor[])) matches the source guard clauses; parameter/return semantics align with the native Skia contracts.
  • B. Examples — scanned all <code> blocks for obsolete-member usage per references/obsolete-api-map.md. Only 4 DrawText example calls exist across the tree; all use the modern (text, x, y, SKTextAlign, font, paint) signature. No obsolete SKPaint.TextSize/Typeface/TextEncoding/TextAlign/... accessors, no old-signature DrawText(text, x, y, paint), no obsolete constructors.
  • C. Quality — swept high-visibility central types (SKPaint, SKCanvas, SKStream, SKFontManager, SKSurface) for the article/verb-tense/spelling patterns the deterministic linter cannot catch (domain-specific misuses of an/a, verb-tense mismatches, single-letter typos inside otherwise-real English words).

Findings summary

Severity Count
CRITICAL 0
MAJOR 0
MINOR 10
FINDING | quality | MINOR | SkiaSharpAPI/SkiaSharp/SKPaint.xml | T:SkiaSharp.SKPaint | "an paint object" appears twice in the type remarks; should be "a paint object" (consonant sound).
FINDING | quality | MINOR | SkiaSharpAPI/SkiaSharp/SKStream.xml | M:SkiaSharp.SKStream.Move(System.Int32) | Summary "Seeks to an relative offset in the stream." — should be "a relative offset" (consonant sound).
FINDING | quality | MINOR | SkiaSharpAPI/SkiaSharp/SKStream.xml | M:SkiaSharp.SKStream.Move(System.Int64) | Same wording issue as the Int32 overload.
FINDING | quality | MINOR | SkiaSharpAPI/SkiaSharp/SKCanvas.xml | M:SkiaSharp.SKCanvas.DrawAnnotation(SkiaSharp.SKRect,System.String,SkiaSharp.SKData) | Summary "Send an key/value pair" fails both patterns.md (verb tense) and article grammar; should be "Sends a key/value pair".
FINDING | quality | MINOR | SkiaSharpAPI/SkiaSharp/SKCanvas.xml | M:SkiaSharp.SKCanvas.DrawAnnotation(SkiaSharp.SKRect,System.String,SkiaSharp.SKData) | Remarks CDATA typo "on may canvas types" — should be "on many canvas types".
FINDING | quality | MINOR | SkiaSharpAPI/SkiaSharp/SKFontManager.xml | M:SkiaSharp.SKFontManager.MatchCharacter(*) | Remarks (repeated across 6 overloads) contain "just pass a ISO 639 here" — should be "an ISO 639" (I reads as a vowel sound).
FINDING | quality | MINOR | SkiaSharpAPI/SkiaSharp/SKFontManager.xml | M:SkiaSharp.SKFontManager.MatchCharacter(*) | Remarks (repeated across 6 overloads) contain "and3166-1" (missing space) — should be "and 3166-1".
FINDING | quality | MINOR | SkiaSharpAPI/SkiaSharp/SKSurface.xml | M:SkiaSharp.SKSurface.DisposeManaged | Summary "Releases managed resources." is terser than the standard SKNativeObject.DisposeManaged wording used in SKManagedStream/SKFrontBufferedManagedStream/SKManagedWStream.

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).

File Change
SkiaSharpAPI/SkiaSharp/SKPaint.xml Type remarks CDATA: "an paint" → "a paint" (2 occurrences).
SkiaSharpAPI/SkiaSharp/SKStream.xml Move(int) and Move(long) summaries: "an relative offset" → "a relative offset".
SkiaSharpAPI/SkiaSharp/SKCanvas.xml DrawAnnotation summary: "Send an key/value pair" → "Sends a key/value pair"; remarks CDATA: "on may canvas types" → "on many canvas types".
SkiaSharpAPI/SkiaSharp/SKFontManager.xml MatchCharacter remarks (6 overloads): "and3166-1" → "and 3166-1"; "just pass a ISO 639 here" → "just pass an ISO 639 here".
SkiaSharpAPI/SkiaSharp/SKSurface.xml DisposeManaged summary aligned with the standard SKNativeObject.DisposeManaged wording used in sibling types.

Deferred

None.

Validation

cd skiasharp && dotnet cake --target=docs-format-docs

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).

Re-run after edits: 0 findings, 0 errors — no broken XML/CDATA, no regressions.

Generated by Auto API Docs Writer · ● 36M ·

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>
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The 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 found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 09f6297:

⚠️ Validation status: warnings

File Status Preview URL Details
SkiaSharpAPI/SkiaSharp/SKCanvas.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKFontManager.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKPaint.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKStream.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKSurface.xml ⚠️Warning 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants