Skip to content

Fill and review API documentation#178

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

Fill and review API documentation#178
github-actions[bot] wants to merge 1 commit into
mainfrom
automation/write-api-docs

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Automated api-docs pass.

Filled

Three new ReadOnlySpan<char> overloads had To be added. placeholders after mdoc stub regeneration. Filled by mirroring the wording of the existing string sibling overloads (accessor verbs and return semantics validated against MemberSignature):

  • SkiaSharpAPI/SkiaSharp/SKColor.xmlParse(ReadOnlySpan<char>), TryParse(ReadOnlySpan<char>, out SKColor)
  • SkiaSharpAPI/SkiaSharp/SKFourByteTag.xmlParse(ReadOnlySpan<char>)
  • SkiaSharpAPI/HarfBuzzSharp/Tag.xmlParse(ReadOnlySpan<char>)

3 files · 4 members · summaries:4 params:5 returns:4 remarks:4

Reviewed

Reviewed the 3 touched files (source-first per the reviewing skill; sibling string overloads treated as the authoritative reference for wording since ROS overloads forward to the same underlying parse). Deterministic lint (docs-format-docs) went from Documentation missing in 4/5026 members to 0/5026 members, 0 findings, 0 errors after edits.

Findings summary

  • CRITICAL: 0
  • IMPORTANT: 0
  • MINOR: 0
(no findings)

Fixed vs deferred

  • Fixed: all 4 in-scope To be added. placeholders.
  • Deferred: none.

Validation

cd skiasharp && dotnet cake --target=docs-format-docs → green (0 findings, 0 errors, 0/5026 missing).

Generated by Auto API Docs Writer · ● 4.7M ·

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 3de5803:

⚠️ Validation status: warnings

File Status Preview URL Details
SkiaSharpAPI/SkiaSharp/SKColor.xml ⚠️Warning Details
SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml ⚠️Warning Details
SkiaSharpAPI/HarfBuzzSharp/Tag.xml ✅Succeeded

SkiaSharpAPI/SkiaSharp/SKColor.xml

  • Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched] SkiaSharp.SKColor's moniker skiasharp can't match any assembly.

SkiaSharpAPI/SkiaSharp/SKFourByteTag.xml

  • Line 0, Column 0: [Warning: ECMA2Yaml_UidAssembly_NotMatched] SkiaSharp.SKFourByteTag's moniker skiasharp can't match any assembly.

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.

@github-actions github-actions Bot closed this Jul 15, 2026
@github-actions
github-actions Bot deleted the automation/write-api-docs branch July 15, 2026 08:55
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