Skip to content

Fill API documentation placeholders#121

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

Fill API documentation placeholders#121
github-actions[bot] wants to merge 1 commit 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

Fills 829 documentation fields across 27 XML files covering:

  • HarfBuzzSharp.Face — named instance APIs, palette color APIs, variation axis APIs
  • HarfBuzzSharp.Font — variation coordinate getters/setters, SetVariations
  • SkiaSharp.GRVkYcbcrComponents / GrVkYcbcrConversionInfo — Vulkan YCbCr structs
  • SkiaSharp.SKCanvas / SKSurface — new DrawSurface/Draw overloads with SKSamplingOptions
  • SkiaSharp.SKColorSpace.CreateCicp — CICP color space factory
  • SkiaSharp.SKColorspacePrimariesCicp / SKColorspaceTransferFnCicp — all CICP enum members with verified standard code point values
  • SkiaSharp.SKColorType — three new enum values (Bgra10101010XR, R16Unorm, RgbF16F16F16x)
  • SkiaSharp.SKDocumentXpsOptions, SKFontArguments, SKFontPaletteOverride, SKFontVariationAxis, SKFontVariationPositionCoordinate, SKFourByteTag — full struct documentation
  • SkiaSharp.SKPaint — six GetFillPath overloads accepting SKPathBuilder
  • SkiaSharp.SKPathBuilder — full type remarks with example + all 51 path-building methods
  • SkiaSharp.SKTypefaceClone overloads, Empty/IsEmpty, variation design parameters
  • SkiaSharp.SKWebpEncoder / SKWebpEncoderFrame — static encoder and frame struct
  • SkiaSharp.Views.Blazor._Imports, Views.Gtk.GTKExtensions, Views.Gtk.SKDrawingArea — platform view members

Review process

Documentation was generated by an AI writer agent, then verified by three independent review agents:

  • Factual Claim Verifier — cross-referenced every claim against C# source and native headers
  • Code Example Verifier — verified API signatures for all code examples
  • Quality Reviewer — checked style, completeness, and pattern compliance

All CRITICAL issues found during review were fixed before merge.

Generated by Auto API Docs Writer · ● 7.4M ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@mattleibow mattleibow closed this May 21, 2026
@learn-build-service-prod
Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 1be369d:

⚠️ 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/SKDocumentXpsOptions.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKPathBuilder.xml ⚠️Warning Details
SkiaSharpAPI/HarfBuzzSharp/Face.xml ✅Succeeded
SkiaSharpAPI/HarfBuzzSharp/Font.xml ✅Succeeded
SkiaSharpAPI/index.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp.Views.Blazor/_Imports.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/GRVkYcbcrComponents.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/GrVkYcbcrConversionInfo.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKCanvas.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKColorSpace.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKColorspacePrimariesCicp.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKColorspaceTransferFnCicp.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKColorType.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKFontArguments.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKFontPaletteOverride.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKFontVariationAxis.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKFontVariationPositionCoordinate.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKMatrix.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKPaint.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKPath.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKPathMeasure.xml ✅Succeeded
SkiaSharpAPI/SkiaSharp/SKStream.xml ✅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.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.Point'.
  • 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'.
  • 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: 'Graphene.Rect'.
  • 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: 'Gdk.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.Color'.
  • 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: 'Graphene.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.Point'.

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.

@github-actions github-actions Bot deleted the automation/write-api-docs branch May 21, 2026 19:25
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