1. Home
  2. Docs
  3. Reference
  4. API Coverage Index

API Coverage Index

The generated API reference under /api is built from these projects:

  • ../src/Svg.Skia/Svg.Skia.csproj
  • ../src/Svg.Skia.JavaScript/Svg.Skia.JavaScript.csproj
  • ../src/Svg.Animation/Svg.Animation.csproj
  • ../src/Svg.SceneGraph/Svg.SceneGraph.csproj
  • ../src/Svg.Model/Svg.Model.csproj
  • ../src/Svg.Custom/Svg.Custom.csproj
  • ../src/Svg.Controls.Avalonia/Svg.Controls.Avalonia.csproj
  • ../src/Svg.Controls.Skia.Avalonia/Svg.Controls.Skia.Avalonia.csproj
  • ../src/Svg.Controls.Skia.Uno/Svg.Controls.Skia.Uno.csproj
  • ../src/Skia.Controls.Avalonia/Skia.Controls.Avalonia.csproj
  • ../src/Svg.Editor.Core/Svg.Editor.Core.csproj
  • ../src/Svg.Editor.Svg/Svg.Editor.Svg.csproj
  • ../src/Svg.Editor.Skia/Svg.Editor.Skia.csproj
  • ../src/Svg.Editor.Avalonia/Svg.Editor.Avalonia.csproj
  • ../src/Svg.Editor.Skia.Avalonia/Svg.Editor.Skia.Avalonia.csproj
  • ../src/ShimSkiaSharp/ShimSkiaSharp.csproj
  • ../src/Svg.SourceGenerator.Skia/Svg.SourceGenerator.Skia.csproj

Build settings

Current API settings:

  • configuration: Release
  • default target framework override: netstandard2.0
  • Avalonia 12 project overrides: Svg.Controls.Avalonia, Svg.Controls.Skia.Avalonia, Skia.Controls.Avalonia, Svg.Editor.Avalonia, and Svg.Editor.Skia.Avalonia build API metadata with net8.0
  • MAUI package coverage: Svg.Controls.Skia.Maui is covered by authored package documentation instead of generated API metadata because the docs workflow runs on Ubuntu and does not install MAUI workloads
  • output path: /api

Why mixed target frameworks

This repository mixes:

  • multi-target runtime packages,
  • shared animation/runtime-host packages,
  • retained-scene graph packages,
  • multi-target editor packages,
  • net10.0 Uno and MAUI control packages,
  • netstandard2.0-only generator packages.

The docs build keeps netstandard2.0 as the default extraction target for the shared runtime and generator-facing packages, while overriding the Avalonia 12 packages to net8.0. The Uno control project uses a per-project override of TargetFramework=net10.0 because it does not target netstandard2.0. The MAUI control package is documented in authored package pages and validated by dedicated MAUI workflow jobs, avoiding a MAUI workload dependency in the Ubuntu docs job.

Svg.CodeGen.Skia

Svg.CodeGen.Skia is described in the authored docs but is not added as a separate api.dotnet project because Svg.SourceGenerator.Skia links the same codegen types into its assembly, which produces duplicate API UIDs during Lunet generation.

When a new package is added

To keep the authored docs and generated API aligned:

  1. Add the project to site/config.scriban under api.dotnet.projects when it can build in the Ubuntu docs workflow without extra platform workloads.
  2. Add any new Avalonia, Uno, or external assembly xrefs under api.dotnet.external_apis if the public API links out to assemblies that are not already covered.
  3. Update Packages and Namespaces and the package article under site/articles/packages/.
  4. Rebuild the site with ./build-docs.sh.