Update API docs from latest CI build#64
Merged
Merged
Conversation
Contributor
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 |
Contributor
There was a problem hiding this comment.
Pull request overview
Automated refresh of the generated XML API documentation to match the latest CI-built NuGet packages, primarily adding compiler/analysis attributes (e.g., IsReadOnly, IsByRefLike, NotNullWhen) and updating some framework-alternate signatures.
Changes:
- Added
System.Runtime.CompilerServices.IsReadOnly/IsByRefLikeattribute metadata to many structs, members, andrefparameters in the API docs. - Added nullable-flow annotation metadata (
NotNullWhen(true)) foroutparameters in Skottie APIs. - Adjusted a few ILAsm
TypeSignatureentries and framework-alternate mappings in Views and Internals docs.
Reviewed changes
Copilot reviewed 71 out of 71 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| SkiaSharpAPI/SkiaSharp/SKWebpEncoderOptions.xml | Documents IsReadOnly on readonly struct and member accessors for newer frameworks. |
| SkiaSharpAPI/SkiaSharp/SKSurfaceProps.xml | Adds IsReadOnly accessor/struct attribute metadata in docs. |
| SkiaSharpAPI/SkiaSharp/SKSizeI.xml | Adds IsReadOnly metadata on members/accessors across framework alternates. |
| SkiaSharpAPI/SkiaSharp/SKSize.xml | Adds IsReadOnly metadata on members/accessors across framework alternates. |
| SkiaSharpAPI/SkiaSharp/SKSamplingOptions.xml | Adds IsReadOnly metadata for the readonly struct. |
| SkiaSharpAPI/SkiaSharp/SKRuntimeEffectUniform.xml | Documents IsByRefLike and IsReadOnly for readonly ref struct. |
| SkiaSharpAPI/SkiaSharp/SKRuntimeEffectChild.xml | Documents IsReadOnly for the struct. |
| SkiaSharpAPI/SkiaSharp/SKRotationScaleMatrix.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKRectI.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKRect.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKRawRunBuffer`1.xml | Adds IsReadOnly metadata for the struct. |
| SkiaSharpAPI/SkiaSharp/SKPointI.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKPoint3.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKPoint.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKPngEncoderOptions.xml | Documents IsReadOnly on readonly struct and member accessors for newer frameworks. |
| SkiaSharpAPI/SkiaSharp/SKPath.xml | Adds IsReadOnly metadata for ref matrix parameters (readonly ref semantics). |
| SkiaSharpAPI/SkiaSharp/SKPMColor.xml | Adds IsReadOnly metadata for the readonly struct. |
| SkiaSharpAPI/SkiaSharp/SKMatrix.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKMask.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKLattice.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKJpegEncoderOptions.xml | Documents IsReadOnly on readonly struct and member accessors for newer frameworks. |
| SkiaSharpAPI/SkiaSharp/SKImageInfo.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKImageFilter.xml | Adds IsReadOnly metadata for ref matrix parameters (readonly ref semantics). |
| SkiaSharpAPI/SkiaSharp/SKHighContrastConfig.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKFontMetrics.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKDrawable.xml | Adds IsReadOnly metadata for ref matrix parameter. |
| SkiaSharpAPI/SkiaSharp/SKDocumentPdfMetadata.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKCubicResampler.xml | Adds IsReadOnly metadata for the readonly struct. |
| SkiaSharpAPI/SkiaSharp/SKColorSpaceXyz.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKColorSpaceTransferFn.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKColorSpacePrimaries.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKColorF.xml | Adds IsReadOnly metadata for the readonly struct. |
| SkiaSharpAPI/SkiaSharp/SKColor.xml | Adds IsReadOnly metadata for the readonly struct. |
| SkiaSharpAPI/SkiaSharp/SKCodecOptions.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKCodecFrameInfo.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/SKCanvasSaveLayerRec.xml | Adds IsReadOnly metadata to property accessors. |
| SkiaSharpAPI/SkiaSharp/SKCanvas.xml | Adds IsReadOnly metadata for several ref parameters (readonly ref semantics). |
| SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/GRVkImageInfo.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/GRVkAlloc.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/GRMtlTextureInfo.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/GRGlTextureInfo.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/GRGlFramebufferInfo.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/GRGlBackendTextureDesc.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/GRBackendTextureDesc.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp/GRBackendRenderTargetDesc.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/SkiaSharp.Views.Mac/ISKGLLayerDelegate.xml | Normalizes ILAsm type signature entries across framework alternates. |
| SkiaSharpAPI/SkiaSharp.Views.Mac/ISKCanvasLayerDelegate.xml | Normalizes ILAsm type signature entries across framework alternates. |
| SkiaSharpAPI/SkiaSharp.Views.Android/SKGLTextureView+ISKRenderer.xml | Adds framework-alternate ILAsm signatures (including beforefieldinit variant). |
| SkiaSharpAPI/SkiaSharp.Views.Android/SKGLSurfaceView+ISKRenderer.xml | Adds framework-alternate ILAsm signatures (including beforefieldinit variant). |
| SkiaSharpAPI/SkiaSharp.Views.Android/GLTextureView+IRenderer.xml | Refines framework-alternate ILAsm signature mapping. |
| SkiaSharpAPI/SkiaSharp.Views.Android/GLTextureView+IGLWrapper.xml | Refines framework-alternate ILAsm signature mapping. |
| SkiaSharpAPI/SkiaSharp.Views.Android/GLTextureView+IEGLWindowSurfaceFactory.xml | Refines framework-alternate ILAsm signature mapping. |
| SkiaSharpAPI/SkiaSharp.Views.Android/GLTextureView+IEGLContextFactory.xml | Refines framework-alternate ILAsm signature mapping. |
| SkiaSharpAPI/SkiaSharp.Views.Android/GLTextureView+IEGLConfigChooser.xml | Refines framework-alternate ILAsm signature mapping. |
| SkiaSharpAPI/SkiaSharp.Skottie/AnimationBuilderStats.xml | Adds IsReadOnly metadata for the struct. |
| SkiaSharpAPI/SkiaSharp.Skottie/Animation.xml | Adds NotNullWhen(true) metadata for out animation parameters. |
| SkiaSharpAPI/SkiaSharp.Internals/IPlatformLock.xml | Normalizes ILAsm type signature entry (beforefieldinit). |
| SkiaSharpAPI/HarfBuzzSharp/Variation.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxisInfo.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/OpenTypeVarAxis.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/OpenTypeNameEntry.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphVariant.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/OpenTypeMathGlyphPart.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/OpenTypeColorLayer.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/GlyphPosition.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/GlyphInfo.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/GlyphExtents.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/FontExtents.xml | Adds IsReadOnly metadata to members/accessors. |
| SkiaSharpAPI/HarfBuzzSharp/Feature.xml | Adds IsReadOnly metadata to members/accessors. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mattleibow
added a commit
that referenced
this pull request
Feb 27, 2026
* Add daily API docs update workflow Full workflow that checks out mono/SkiaSharp at a configurable branch, installs GTK# 2 MSI, and runs Cake doc generation targets. Supports a skiasharp-branch parameter to generate docs from any SkiaSharp branch. Schedule: daily at 6 AM UTC, plus manual workflow_dispatch. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update API docs from latest CI build (#64) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Add go-live workflow to publish docs to live branch (#65) Manual workflow_dispatch that creates a PR from main to live. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Matthew Leibowitz <mattleibow@live.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated update of XML API documentation generated from the latest CI NuGet packages.
This PR was created by the Update API Docs workflow.