docs: XML docs + pack-only doc generation #5
Conversation
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
…able, and Tuple - Add/translate English XML documentation for public APIs - Ensure <param> and <typeparam> tags are complete and XML is valid - No functional changes
- Multi-target only during pack - Generate XML docs only when packing - Keep dev builds single-target - Include .xml in nupkg output
s2quake
force-pushed
the
chore/document
branch
from
4be1a37 to
4196faa
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #5 +/- ##
==========================================
+ Coverage 98.93% 99.14% +0.21%
==========================================
Files 4 4
Lines 469 469
Branches 87 87
==========================================
+ Hits 464 465 +1
Misses 2 2
+ Partials 3 2 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
s2quake
force-pushed
the
chore/document
branch
from
6f132b7 to
bcdc07a
Compare
- Fully qualify List/HashSet/SortedSet/Dictionary cref targets to System.Collections.Generic - Fixes CS0419 ambiguity with method overloads in XML docs
s2quake
force-pushed
the
chore/document
branch
from
bcdc07a to
b560d68
Compare
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.
Docs: XML IntelliSense + pack-only doc generation
This PR improves developer experience and packaging:
Summary
RandomUtility,RandomUtility.Nullable, andRandomUtility.Tuple.dotnet packto avoid stray XML outputs in dev builds, while ensuring IntelliSense docs ship in the NuGet package.Changes
CI/Release context (existing on main)
dorny/test-reporterusing TRXNotes
dotnet buildanddotnet pack; nupkg contains XML docs next to assemblies.