Skip to content

Fill API documentation placeholders#138

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

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

What changed

Filled documentation for 32 types across HarfBuzzSharp, SkiaSharp, and SkiaSharp.Views namespaces — 948 fields merged into XML.

Types documented

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

Process

This documentation was generated through a multi-phase AI pipeline:

  1. Write — One agent read all JSON stubs and corresponding C# source, then filled every To be added. placeholder with accurate documentation.
  2. Review — Three independent agents verified the output:
    • Factual Claim Verifier (cross-referenced every claim against source)
    • Code Example Verifier (verified all API calls exist with correct signatures)
    • Quality Reviewer (checked style, completeness, and naming)
  3. Fix — All CRITICAL issues found by reviewers were corrected before merge, including:
    • Wrong return types on Span<T> overloads (GetNamedInstanceDesignCoords, GetPaletteColors)
    • Wrong 2.14 fixed-point range for SetVariationCoordsNormalized coords parameter
    • Wrong byte count for SKColorType.Bgra10101010XR (5→8 bytes)
    • Phantom cullRect params on two SKPaint.GetFillPath overloads
    • Phantom direction/dx/dy params on SKPathBuilder methods
    • Wrong source type in ColorExtensions.ToHBColor(SKColorF) summary
    • Wrong description for ColorExtensions.ToSKColors(HBColor[]) summary
    • Spurious phantom params in ColorExtensions extension methods
    • Incorrect <returns> on void _Imports.Execute method
    • Wrong type in GTKExtensions.ToGdkRGBA(SKColorF) summary
    • Code example using zero-quality new SKWebpEncoderOptions()SKWebpEncoderOptions.Default
    • Unverified 72 DPI fallback claim for SKDocumentXpsOptions.Dpi

Generated by Auto API Docs Writer · ● 14.9M ·

Automated AI-generated documentation for XML API docs with 'To be added.'
placeholders. Covers 32 types across HarfBuzzSharp, SkiaSharp, and
SkiaSharp.Views namespaces — 948 fields merged.

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 e3d0167:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
SkiaSharpAPI/HarfBuzzSharp.Internals/PlatformConfiguration.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/Blob.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/Buffer.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/BufferDiffFlags.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/BufferFlags.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/ClusterLevel.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/CombiningClassDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/ComposeDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/ContentType.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/DecomposeDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/Direction.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/Face.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/Feature.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/Font.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/FontExtents.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/FontExtentsDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/FontFunctions.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/GeneralCategoryDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/GetTableDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/GlyphAdvanceDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/GlyphAdvancesDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/GlyphContourPointDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/GlyphExtents.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/GlyphExtentsDelegate.xml ❌Error Details
SkiaSharpAPI/HarfBuzzSharp/GlyphFlags.xml ❌Error Details

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

SkiaSharpAPI/HarfBuzzSharp.Internals/PlatformConfiguration.xml

  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.
  • Line 0, Column 0: [Error: moniker-range-invalid] Invalid moniker range: Moniker 'harfbuzzsharp-14.2' is not defined.

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