Skip to content

Fill and review API documentation - #193

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

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

Conversation

@github-actions

@github-actions github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Automated daily API-docs pass driven by the api-docs skill.

Filled (4 files)

Type and member summaries for four newly-shipped enums under SkiaSharpAPI/SkiaSharp/:

  • SKGraphiteBackend — type + 4 members (Dawn, Metal, Vulkan, Unknown)
  • SKGraphiteInsertStatus — type + 6 members
  • SKImageRescaleMode — type + 4 members (Nearest, Linear, RepeatedLinear, RepeatedCubic)
  • SKImageRescaleGamma — type + 2 members (Src, Linear)

All names, numeric values, and semantics were verified against skiasharp/binding/SkiaSharp/SkiaApi.generated.cs (the sk_graphite_backend_t, sk_graphite_insert_status_t, sk_image_rescale_mode_t, sk_image_rescale_gamma_t mappings).

Reviewed (4 files)

The four filled files were sanity-checked against source:

  • Factual — enum member names and numeric values match the C mapping comments in SkiaApi.generated.cs.
  • Examples — no code examples were added in this pass (enum types); no obsolete API risk.
  • Quality<summary> uses .NET-conventional voice; short single sentences; type summaries reference the owning types via <see cref>.

Findings summary

Severity Count
CRITICAL 0
IMPORTANT 0
MINOR 0

Deterministic lint (docs-format-docs) reported 0 findings, 0 errors both before and after the edits. Type/member missing-docs counters dropped from 23/453 types & 171/5197 members to 22/453 & 155/5197.

FINDING | (none) | | |

Fixed vs deferred

  • Fixed: the 4 enum types listed above (type summary + every member summary).
  • Deferred (next run): remaining To be added. placeholders on larger Graphite surface types (SKGraphiteContext, SKGraphiteRecorder, SKGraphiteContextOptions, SKGraphiteBackendTexture, SKGraphite*BackendContext*, SKGraphiteVkTextureInfo, SKGraphiteSubmitInfo, SKGraphiteInsertRecordingInfo, SKGraphiteImageCache, SKGraphiteRecording, SKGraphiteTextureInfo, SKGraphite*Delegate), plus SKImage/SKSurface/GRContext/GRVkExtensions/SKImageReadPixelsResult new members. These require reading struct/class source and, for type-level docs, a compiling example — timeboxed out of this pass.

Validation

cd skiasharp && dotnet cake --target=docs-format-docs — green (0 errors, 0 lint findings) after edits.

Generated by Auto API Docs Writer · ● 4M ·

Filled type and member summaries for four new Graphite/Image enums:
- SKGraphiteBackend
- SKGraphiteInsertStatus
- SKImageRescaleMode
- SKImageRescaleGamma

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 8e1583b:

✅ Validation status: passed

File Status Preview URL Details
SkiaSharpAPI/SkiaSharp/SKGraphiteBackend.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKGraphiteInsertStatus.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKImageRescaleGamma.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKImageRescaleMode.xml ✅Succeeded

For more details, please refer to the build report.

@mattleibow

Copy link
Copy Markdown
Collaborator

Closing per the requested cleanup of generated documentation-update PRs. This scheduled run used the old main-branch workflow/skill contract (Opus 4.7 and the stale FINDING | output), not PR #186 or the hardened SkiaSharp skill branch, so it is not part of the validated workflow work.

@mattleibow mattleibow closed this Aug 5, 2026
@github-actions
github-actions Bot deleted the automation/write-api-docs branch August 8, 2026 08:31
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.

1 participant