Skip to content

Fill API documentation placeholders#117

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

Fill API documentation placeholders#117
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 817 documentation fields across 29 XML files covering:

  • HarfBuzzSharp.Face — variation axis and color palette methods/properties
  • HarfBuzzSharp.Font — variation coordinate methods
  • SkiaSharp.GRVkYcbcrComponents / GrVkYcbcrConversionInfo — Vulkan YCbCr structs
  • SkiaSharp.SKCanvas, SKSurface, SKPaint, SKPath, SKPathBuilder, SKPathMeasure, SKStream
  • SkiaSharp.SKColorSpace, SKColorspacePrimariesCicp, SKColorspaceTransferFnCicp, SKColorType
  • SkiaSharp.SKDocumentXpsOptions, SKFontArguments, SKFontPaletteOverride, SKFontVariationAxis, SKFontVariationPositionCoordinate, SKFourByteTag
  • SkiaSharp.SKTypeface, SKWebpEncoder, SKWebpEncoderFrame
  • SkiaSharp.Views.Blazor._Imports, SkiaSharp.Views.Gtk.GTKExtensions, SKDrawingArea

Review process

Documentation was written by a general-purpose agent, then reviewed by three independent agents (factual claim verifier, code example verifier, quality reviewer). Critical issues found and fixed before merge:

  • GRVkYcbcrComponents remarks example: removed reference to VkComponentSwizzle (not in SkiaSharp bindings); replaced with numeric literals
  • SKWebpEncoderFrame remarks example: fixed constructor calls to use correct (pixmap, TimeSpan) signature and TimeSpan.FromMilliseconds() for duration
  • SKWebpEncoder remarks example: added null check before calling .ToArray() on nullable SKData? return value

Generated by Auto API Docs Writer · ● 12.4M ·

github-actions Bot and others added 2 commits May 21, 2026 03:07
Complete all 'To be added.' entries across all 27 JSON files in
output/docs-work/ with accurate .NET XML documentation for
SkiaSharp and HarfBuzzSharp APIs.

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 9ac7d0d:

⚠️ 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.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.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.Color'.
  • 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: 'Graphene.Point'.
  • 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.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.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.Color'.
  • 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.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.

@mattleibow
Copy link
Copy Markdown
Collaborator

Closing to allow second validation run. Review findings documented.

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