Skip to content

Fill API documentation placeholders#126

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

Fill API documentation placeholders#126
github-actions[bot] wants to merge 2 commits into
mainfrom
automation/write-api-docs

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Automated AI-generated documentation for XML API docs with 'To be added.' placeholders.

Summary

Filled 948 fields across 32 types including:

  • HarfBuzzSharp.Face, Font, HBColor
  • SkiaSharp.GRContext, GRVkYcbcrComponents, GRVkYcbcrConversionInfo
  • SkiaSharp.SKCanvas, SKColorSpace, SKColorspacePrimariesCicp, SKColorspaceTransferFnCicp
  • SkiaSharp.SKColorType, SKDocument, SKDocumentXpsOptions
  • SkiaSharp.SKFontArguments, SKFontPaletteOverride, SKFontVariationAxis, SKFontVariationPositionCoordinate, SKFourByteTag
  • SkiaSharp.SKMaskFilter, SKPaint, SKPath, SKPathBuilder, SKPathMeasure, SKStream, SKSurface, SKTypeface
  • SkiaSharp.SKWebpEncoder, SKWebpEncoderFrame
  • SkiaSharp.HarfBuzz.ColorExtensions
  • SkiaSharp.Views.Blazor._Imports, SkiaSharp.Views.Gtk.GTKExtensions, SKDrawingArea

All documentation was verified against C# source in binding/ before writing.

Generated by Auto API Docs Writer · ● 8.8M ·

github-actions Bot and others added 2 commits May 24, 2026 09:21
Complete all 'To be added.' entries in output/docs-work/ with accurate
.NET XML API documentation for SkiaSharp and HarfBuzzSharp types:

- HarfBuzzSharp: Face (variation/palette APIs), Font (variation coords), HBColor (BGRA struct)
- SkiaSharp: GRContext, GRVkYcbcrComponents, GRVkYcbcrConversionInfo
- SkiaSharp: SKCanvas (DrawSurface with SKSamplingOptions)
- SkiaSharp: SKColorSpace (CreateCicp), SKColorspacePrimariesCicp, SKColorspaceTransferFnCicp
- SkiaSharp: SKColorType (Bgra10101010XR, RgbF16F16F16x, R16Unorm)
- SkiaSharp: SKDocument (CreateXps overloads), SKDocumentXpsOptions
- SkiaSharp: SKFontArguments, SKFontPaletteOverride, SKFontVariationAxis
- SkiaSharp: SKFontVariationPositionCoordinate, SKFourByteTag
- SkiaSharp: SKMaskFilter (CreateShader), SKPaint (GetFillPath/SKPathBuilder overloads)
- SkiaSharp: SKPath (Handle), SKPathBuilder (51 entries, full type remarks)
- SkiaSharp: SKPathMeasure (GetSegment/SKPathBuilder), SKStream (GetData)
- SkiaSharp: SKSurface (Draw with SKSamplingOptions), SKTypeface (Clone, Empty, VariationDesign*)
- SkiaSharp: SKWebpEncoder, SKWebpEncoderFrame
- SkiaSharp.HarfBuzz: ColorExtensions (ToHBColor/ToSKColor/ToSKColors)
- SkiaSharp.Views.Blazor: _Imports (Execute)
- SkiaSharp.Views.Gtk: GTKExtensions (13 conversion extensions), SKDrawingArea (Dispose)

All fields listed in _extractedKeys are filled; type-level entries with
remarksRequired=true include full CDATA remarks blocks with examples.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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 411d802:

⚠️ Validation status: warnings

File Status Preview URL Details
SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/GRVkImageInfo.xml ⚠️Warning Details
output/docs-work/HarfBuzzSharp__Face.json ✅Succeeded
output/docs-work/HarfBuzzSharp__Font.json ✅Succeeded
output/docs-work/HarfBuzzSharp__HBColor.json ✅Succeeded
output/docs-work/manifest.json ✅Succeeded
output/docs-work/SkiaSharp__GRContext.json ✅Succeeded
output/docs-work/SkiaSharp__GRVkYcbcrComponents.json ✅Succeeded
output/docs-work/SkiaSharp__GRVkYcbcrConversionInfo.json ✅Succeeded
output/docs-work/SkiaSharp__SKCanvas.json ✅Succeeded
output/docs-work/SkiaSharp__SKColorSpace.json ✅Succeeded
output/docs-work/SkiaSharp__SKColorspacePrimariesCicp.json ✅Succeeded
output/docs-work/SkiaSharp__SKColorspaceTransferFnCicp.json ✅Succeeded
output/docs-work/SkiaSharp__SKColorType.json ✅Succeeded
output/docs-work/SkiaSharp__SKDocument.json ✅Succeeded
output/docs-work/SkiaSharp__SKDocumentXpsOptions.json ✅Succeeded
output/docs-work/SkiaSharp__SKFontArguments.json ✅Succeeded
output/docs-work/SkiaSharp__SKFontPaletteOverride.json ✅Succeeded
output/docs-work/SkiaSharp__SKFontVariationAxis.json ✅Succeeded
output/docs-work/SkiaSharp__SKFontVariationPositionCoordinate.json ✅Succeeded
output/docs-work/SkiaSharp__SKFourByteTag.json ✅Succeeded
output/docs-work/SkiaSharp__SKMaskFilter.json ✅Succeeded
output/docs-work/SkiaSharp__SKPaint.json ✅Succeeded
output/docs-work/SkiaSharp__SKPath.json ✅Succeeded

This comment lists only the first 25 files in the pull request.

SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Size'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Size'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Point'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Point'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Point'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Point'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Color'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Color'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.RGBA'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Color'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Rectangle'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Size'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Pixbuf'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Gdk.Rectangle'.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
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