Skip to content

Fill API documentation placeholders#118

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

Fill API documentation placeholders#118
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 fields across 27 XML documentation files. Types documented include:

  • HarfBuzzSharp: Face, Font
  • SkiaSharp: GRVkYcbcrComponents, GrVkYcbcrConversionInfo, SKCanvas, SKColorSpace, SKColorspacePrimariesCicp, SKColorspaceTransferFnCicp, SKColorType, SKDocumentXpsOptions, SKFontArguments, SKFontPaletteOverride, SKFontVariationAxis, SKFontVariationPositionCoordinate, SKFourByteTag, SKPaint, SKPath, SKPathBuilder, SKPathMeasure, SKStream, SKSurface, SKTypeface, SKWebpEncoder, SKWebpEncoderFrame
  • SkiaSharp.Views.Blazor: _Imports
  • SkiaSharp.Views.Gtk: GTKExtensions, SKDrawingArea

Review

Three independent review agents (Factual Claim Verifier, Code Example Verifier, Quality Reviewer) validated the generated documentation. Critical issues found and fixed:

  • SKFourByteTag: Corrected constructor chars in code example ('w','e','i','g''w','g','h','t' for "wght" tag)
  • SKColorType.Bgra10101010XR: Fixed description — fourth channel is Alpha, not "unused padding" (verified against Skia SkColorType.h)
  • SKDocumentXpsOptions.AllowNoPngs: Fixed boolean <value> pattern from "true to..." to "true if..."
  • SKWebpEncoder / SKWebpEncoderFrame: Added null checks in code examples (methods return SKData?)

Generated by Auto API Docs Writer · ● 11M ·

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

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 6e24aaa:

⚠️ 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.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.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.Rect'.
  • 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.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.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: 'Graphene.Point3D'.
  • 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.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.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'.

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.

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