Skip to content

Fill and review API documentation - #185

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

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

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Fills all remaining To be added. placeholders detected by the docs-format-docs pass (20 members across 7 types, all in the SkiaSharp namespace) and reviews the affected files.

Filled (7 files)

  • SkiaSharp/GRContext.xmlCheckAsyncWorkCompletion
  • SkiaSharp/GRVkExtensions.xml — default constructor
  • SkiaSharp/SKImage.xml — both RequestReadPixels overloads
  • SkiaSharp/SKSurface.xml — both RequestReadPixels overloads
  • SkiaSharp/SKImageRescaleGamma.xml — type + Src, Linear
  • SkiaSharp/SKImageRescaleMode.xml — type + Nearest, Linear, RepeatedLinear, RepeatedCubic
  • SkiaSharp/SKImageReadPixelsResult.xml — type + PlaneCount, GetPlaneData, GetPlaneRowBytes, CopyPlaneTo, ToArray, ToBitmap, ToImage, Dispose

All prose was written after reading the corresponding source in binding/SkiaSharp/ (SKImage.cs, SKSurface.cs, GRContext.cs, GRVkExtensions.cs, SKImageReadPixelsResult.cs, and the enum definitions in SkiaApi.generated.cs). Cross-references between the async-read API surface (RequestReadPixelsSKImageReadPixelsResultSKImageRescaleGamma/ModeGRContext.CheckAsyncWorkCompletion) are wired up with <see cref>.

Reviewed (7 files)

Same file set. The three reviewers from references/reviewing.md were applied:

  • A. Factual — accessor verbs, parameter roles, disposal semantics (SKImageReadPixelsResult valid only during the callback), and single-plane restrictions on ToImage/ToBitmap verified against source.
  • B. Examples — no new code examples were added; no obsolete members introduced.
  • C. Quality — .NET XML conventions, cross-links use T:/M:/P:/F: prefixes, no restatement of reference-table facts.

Findings summary

Deterministic lint before → after this run:

  • Before: Documentation missing in 3/433 (0.7%) types and 20/5046 (0.4%) members, 0 findings, 0 errors.
  • After: Documentation missing in 0/433 (0.0%) types and 0/5046 (0.0%) members, 0 findings, 0 errors.

No FINDING | lines were emitted by the deterministic checks and no additional CRITICAL correctness issues were identified in the reviewed files.

FINDING | (none)

Fixed vs deferred

  • Fixed: all 20 missing-doc placeholders listed above.
  • Deferred: none.

Validation

cd skiasharp && dotnet cake --target=docs-format-docs re-run after edits: 0 findings, 0 errors, no missing docs. All edited files parse as well-formed XML.

Generated by Auto API Docs Writer · ● 12.4M ·

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 00d02dc:

⚠️ Validation status: warnings

File Status Preview URL Details
SkiaSharpAPI/SkiaSharp/GRContext.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/GRVkExtensions.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKImage.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKSurface.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKImageReadPixelsResult.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKImageRescaleGamma.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKImageRescaleMode.xml ✅Succeeded

SkiaSharpAPI/SkiaSharp/GRContext.xml

  • Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched] SkiaSharp.GRContext's moniker skiasharp can't match any assembly.

SkiaSharpAPI/SkiaSharp/GRVkExtensions.xml

  • Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched] SkiaSharp.GRVkExtensions's moniker skiasharp can't match any assembly.

SkiaSharpAPI/SkiaSharp/SKImage.xml

  • Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched] SkiaSharp.SKImage'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