Fill and review API documentation - #185
Conversation
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 00d02dc:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| SkiaSharpAPI/SkiaSharp/GRContext.xml | Details | ||
| SkiaSharpAPI/SkiaSharp/GRVkExtensions.xml | Details | ||
| SkiaSharpAPI/SkiaSharp/SKImage.xml | Details | ||
| SkiaSharpAPI/SkiaSharp/SKSurface.xml | 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.
Fills all remaining
To be added.placeholders detected by thedocs-format-docspass (20 members across 7 types, all in theSkiaSharpnamespace) and reviews the affected files.Filled (7 files)
SkiaSharp/GRContext.xml—CheckAsyncWorkCompletionSkiaSharp/GRVkExtensions.xml— default constructorSkiaSharp/SKImage.xml— bothRequestReadPixelsoverloadsSkiaSharp/SKSurface.xml— bothRequestReadPixelsoverloadsSkiaSharp/SKImageRescaleGamma.xml— type +Src,LinearSkiaSharp/SKImageRescaleMode.xml— type +Nearest,Linear,RepeatedLinear,RepeatedCubicSkiaSharp/SKImageReadPixelsResult.xml— type +PlaneCount,GetPlaneData,GetPlaneRowBytes,CopyPlaneTo,ToArray,ToBitmap,ToImage,DisposeAll 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 inSkiaApi.generated.cs). Cross-references between the async-read API surface (RequestReadPixels↔SKImageReadPixelsResult↔SKImageRescaleGamma/Mode↔GRContext.CheckAsyncWorkCompletion) are wired up with<see cref>.Reviewed (7 files)
Same file set. The three reviewers from
references/reviewing.mdwere applied:SKImageReadPixelsResultvalid only during the callback), and single-plane restrictions onToImage/ToBitmapverified against source.T:/M:/P:/F:prefixes, no restatement of reference-table facts.Findings summary
Deterministic lint before → after this run:
Documentation missing in 3/433 (0.7%) types and 20/5046 (0.4%) members,0 findings, 0 errors.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.Fixed vs deferred
Validation
cd skiasharp && dotnet cake --target=docs-format-docsre-run after edits: 0 findings, 0 errors, no missing docs. All edited files parse as well-formed XML.