Enable XML doc generation for API reference docs#373
Merged
mattleibow merged 4 commits intomainfrom Mar 4, 2026
Merged
Conversation
…aSharp.Extended core library Add /// <summary>, /// <param>, /// <returns>, and /// <exception> XML doc comments to all public classes, methods, properties, and constructors in: - SKBlurHash - SKPixelComparer - SKPixelComparisonResult - SKGeometry - SKGeometryExtensions - SKPathInterpolation Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: mattleibow <1096616+mattleibow@users.noreply.github.com>
…aSharp.Extended.UI.Maui Add XML doc comments (/// <summary>, /// <param>, /// <returns>) to all public classes, structs, enums, properties, methods, constructors, fields, and events in the SkiaSharp.Extended.UI.Maui project to eliminate CS1591 warnings. Files documented: - Base controls: SKSurfaceView, SKAnimatedSurfaceView, StringTypeConverter - Confetti controls: SKConfettiView, SKConfettiSystem, SKConfettiEmitter, SKConfettiEmitterBounds, SKConfettiPhysics, SKConfettiShape (and subtypes), all collection types and type converters - Lottie controls: SKLottieView, SKLottieAnimation, SKLottieImageSource (and subtypes), event args, type converters - Resource dictionaries: SKSurfaceViewResources, SKConfettiViewResources, SKLottieViewResources - Enums: SKConfettiEmitterSide, SKLottieRepeatMode Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Investigate missing API documentation
Enable XML doc generation for API reference docs
Mar 3, 2026
|
📖 Documentation Preview The documentation for this PR has been deployed and is available at: This preview will be updated automatically when you push new commits to this PR. This comment is automatically updated by the documentation staging workflow. |
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
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.
DocFX API pages were empty shells — types and methods listed but zero descriptions, summaries, or parameter docs. Two root causes:
GenerateDocumentationFilewas never enabled, so no.xmlfiles were emitted alongside DLLs/// <summary>) existed anywhere in the sourceChanges
source/Directory.Build.props— EnableGenerateDocumentationFilefor all projectsSkiaSharp.Extended(6 files) — Add XML doc comments to all public types/members:SKBlurHash,SKPixelComparer,SKPixelComparisonResult,SKGeometry,SKGeometryExtensions,SKPathInterpolationSkiaSharp.Extended.UI.Maui(30 files) — Add XML doc comments to all public types/members: confetti controls, Lottie controls, base surface views, type converters, enums, collectionsBoth projects now build with zero CS1591 warnings. DocFX metadata generation picks up the XML files and populates API pages with summaries, parameter descriptions, return types, and exception documentation.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
mono.github.io/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.