Fix obsolete cross-references in API docs (DrawInSurface, ISKRenderer, SKPaint text props)#173
Merged
Merged
Conversation
…, SKPaint text props) Resolve 36 xref-not-found build warnings caused by dangling <xref:> links in 2019-era hand-written remarks that point at members removed/relocated by the latest-only-monikers regeneration (#141). - Group 1 (24): remove obsolete pre-v1.68 DrawInSurface [!NOTE] blocks from the Apple Mac/iOS/tvOS SKCanvasLayer/SKCanvasView/SKGLLayer/SKGLView views. - Group 2 (4): drop obsolete ISKRenderer/SetRenderer [!NOTE] blocks from the Android SKGLSurfaceView/SKGLTextureView; surrounding prose already documents the modern OnPaintSurface/PaintSurface pattern. - Group 3 (4): repoint SKTypeface remarks from removed SKPaint text properties (TextSize/TextSkewX/TextScaleX/FakeBoldText) to their SKFont equivalents (Size/SkewX/ScaleX/Embolden) and fix the surrounding sentence. Unblocks Go Live PR #171. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
Contributor
PoliCheck Scan ReportThe 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 foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
mattleibow
added a commit
that referenced
this pull request
Jun 30, 2026
Go Live: publish latest API docs (#171) Publish the accumulated SkiaSharp / HarfBuzzSharp API documentation from main to the live (published) branch. This is the first Go Live since #66 and rolls up a large batch of docs automation, a full regeneration, and content/cross-reference cleanup. Highlights in this batch: - Docs automation: automated API docs writer (#92, hardened in #155), daily update workflow, go-live workflow (#65), and a Learn Build status-based auto-merge gate (#82, #83) backed by check-learn-build.py and a .github/known-warnings.csv baseline. - Regeneration: frameworks docs switched to latest-only monikers (#141), baseline reset to the Windows-generated output (#142), and stub regeneration moved to Linux via Mono (#147). This drops older, no-longer-shipping member/type pages (e.g. pre-v1.68 view APIs, the removed Android ISKRenderer interface, and the SKPaint text properties that moved to SKFont). - Content: filled API documentation placeholders (#150, #151, #172) and fixed broken cross-references (#152). - Cross-reference cleanup (#173): removed/repointed 36 obsolete xref-not-found references left behind by the latest-only-moniker regeneration — dangling links in 2019-era remarks to members that were since removed or relocated. Without this the Go Live build reported 160 warnings and the auto-merge gate (correctly) blocked the publish. Build health at publish: 0 errors, 124 warnings, 0 suggestions. All 124 remaining warnings are expected xref-not-found references to external framework types (OpenTK, Gdk/Cairo/Graphene, ElmSharp/Tizen.NUI, Windows.UI.Xaml, Microsoft.UI.Xaml, SharpVk, Vortice) that Learn cannot resolve and which are tracked in the known-warnings.csv baseline — 0 new warnings versus baseline, so the gate passes. Co-authored-by: Matthew Leibowitz <mattleibow@live.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 36
xref-not-foundbuild warnings that were blocking the Go Live publish (#171). These are dangling<xref:>links in 2019-era hand-written conceptual prose (<remarks>/[!NOTE]blocks) that point at SkiaSharp API members which were later removed or relocated. The link targets disappeared when commit1dd7575("Regenerate frameworks docs: latest-only monikers (#141)") dropped the old member/type pages, but the prose linking to them was never updated.These are ECMA/mdoc XML docs — the
<remarks>/<summary>prose is hand-authored and preserved across regeneration, so editing the prose is the correct, safe fix. No generated<Member>signatures or<Parameters>were touched.Changes per group
Group 1 — Obsolete Apple
DrawInSurfacenotes (24 instances)Removed the obsolete
> [!NOTE]blocks that told pre-v1.68 users to overrideDrawInSurfaceinstead ofOnPaintSurface.DrawInSurfacewas removed after v1.68.x (replaced byOnPaintSurface), so the note is ~8 years obsolete.SkiaSharp.Views.Mac/{SKCanvasLayer,SKCanvasView,SKGLLayer,SKGLView}.xmlSkiaSharp.Views.iOS/{SKCanvasLayer,SKCanvasView,SKGLLayer,SKGLView}.xmlSkiaSharp.Views.tvOS/{SKCanvasLayer,SKCanvasView,SKGLLayer,SKGLView}.xmlGroup 2 — Obsolete Android
ISKRendererreferences (4 instances)Removed the obsolete
> [!NOTE]blocks referencing the removed nestedISKRendererinterface andSetRenderer(ISKRenderer)method. The surrounding remarks already document the modern pattern (overrideOnPaintSurface/ subscribe to thePaintSurfaceevent), so the docs remain coherent and accurate.SkiaSharp.Views.Android/{SKGLSurfaceView,SKGLTextureView}.xmlGroup 3 — Repoint
SKTypefacexrefs toSKFont(4 instances)The four
SKPainttext properties were removed and now live onSKFont. Repointed the xrefs (targets verified to exist inSKFont.xml) and updated the surrounding sentence ("used in the paint" → "used in the font"):SKPaint.TextSize→SKFont.SizeSKPaint.TextSkewX→SKFont.SkewXSKPaint.TextScaleX→SKFont.ScaleXSKPaint.FakeBoldText→SKFont.EmboldenVerification
grepconfirms zero remaining references toDrawInSurface,ISKRenderer,SetRenderer(SKGL…),SKPaint.TextSize,SKPaint.TextSkewX,SKPaint.TextScaleX,SKPaint.FakeBoldText. The only remainingSetRendererhit is the legitimateGLTextureView.SetRenderer(GLTextureView.IRenderer)API member (unrelated, kept).SKFontxref targets exist as<Member MemberName="Size|SkewX|ScaleX|Embolden">inSkiaSharp/SKFont.xml..github/known-warnings.csvis not modified — we are fixing these warnings, not allowlisting them.Unblocks Go Live PR #171.
Co-authored-by: Copilot App 223556219+Copilot@users.noreply.github.com