Skip to content

Fill API documentation placeholders#113

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

Fill API documentation placeholders#113
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.

Changes

Filled documentation placeholders across 29 XML files (829 fields) covering:

  • HarfBuzzSharp.Face — palette color methods, name table, serialization
  • HarfBuzzSharp.Font — variation coordinates, OpenType methods
  • SkiaSharp.GRVkYcbcrComponents / GrVkYcbcrConversionInfo — Vulkan YCbCr conversion structs
  • SkiaSharp.SKCanvas — new drawing methods
  • SkiaSharp.SKColorSpace — CICP factory
  • SkiaSharp.SKColorspacePrimariesCicp / SKColorspaceTransferFnCicp — CICP enum members
  • SkiaSharp.SKColorType — new color type enum members
  • SkiaSharp.SKDocumentXpsOptions — XPS document options struct
  • SkiaSharp.SKFontArguments / SKFontPaletteOverride / SKFontVariationAxis / SKFontVariationPositionCoordinate / SKFourByteTag — font variation APIs
  • SkiaSharp.SKPaint / SKPath / SKPathBuilder / SKPathMeasure / SKStream / SKSurface / SKTypeface — core drawing APIs
  • SkiaSharp.SKWebpEncoder / SKWebpEncoderFrame — animated WebP encoding
  • SkiaSharp.Views.Blazor._Imports / SkiaSharp.Views.Gtk.GTKExtensions / SKDrawingArea — platform views

Review fixes applied

  • SKColorType.Bgra10101010XR: corrected "40 bits" → "64 bits (8 bytes per pixel)"
  • SKPathBuilder.Snapshot: corrected "immutable snapshot" → "copy" (SKPath is mutable)
  • SKPath.Handle: corrected "Gets or sets" → "Gets" (setter is protected)

Generated by Auto API Docs Writer · ● 15.3M ·

github-actions Bot and others added 2 commits May 20, 2026 21:57
Complete all 'To be added.' fields with accurate .NET XML documentation
for SkiaSharp and HarfBuzzSharp APIs. Covers:

- HarfBuzzSharp: Face (21 entries), Font (6 entries)
- SkiaSharp: GRVkYcbcrComponents, GrVkYcbcrConversionInfo, SKCanvas,
  SKColorSpace, SKColorspacePrimariesCicp, SKColorspaceTransferFnCicp,
  SKColorType, SKDocumentXpsOptions, SKFontArguments, SKFontPaletteOverride,
  SKFontVariationAxis, SKFontVariationPositionCoordinate, SKFourByteTag,
  SKPaint, SKPath, SKPathBuilder (51 entries), SKPathMeasure, SKStream,
  SKSurface, SKTypeface, SKWebpEncoder, SKWebpEncoderFrame
- SkiaSharp.Views.Blazor: _Imports
- SkiaSharp.Views.Gtk: GTKExtensions (13 entries), SKDrawingArea

Also fixes a LineTo/MoveTo summary swap in SKPathBuilder.json.

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

Learn Build status updates of commit 5fc5d79:

⚠️ Validation status: warnings

File Status Preview URL Details
SkiaSharpAPI/SkiaSharp.Views.Gtk/GTKExtensions.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp.Views.Gtk/SKDrawingArea.xml ⚠️Warning Details
output/docs-work/HarfBuzzSharp__Face.json ✅Succeeded
output/docs-work/HarfBuzzSharp__Font.json ✅Succeeded
output/docs-work/manifest.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__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__SKPaint.json ✅Succeeded
output/docs-work/SkiaSharp__SKPath.json ✅Succeeded
output/docs-work/SkiaSharp__SKPathBuilder.json ✅Succeeded
output/docs-work/SkiaSharp__SKPathMeasure.json ✅Succeeded
output/docs-work/SkiaSharp__SKStream.json ✅Succeeded
output/docs-work/SkiaSharp__SKSurface.json ✅Succeeded
output/docs-work/SkiaSharp__SKTypeface.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.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: 'Graphene.Point'.
  • 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.RGBA'.
  • 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.RGBA'.
  • 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.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.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'.
  • 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.Rectangle'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Graphene.Point3D'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Graphene.Rect'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Graphene.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.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'.
  • 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'.

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.

@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.

@mattleibow mattleibow closed this May 20, 2026
@mattleibow mattleibow deleted the automation/write-api-docs branch May 20, 2026 23:39
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