Skip to content

docs: XML docs + pack-only doc generation #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
s2quake merged 5 commits into from
Nov 2, 2025
Merged

docs: XML docs + pack-only doc generation #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2dda284
docs(random): translate and complete XML docs for RandomUtility, Null…
s2quake Nov 2, 2025
e0c265e
build(pack): condition pack-only settings at PropertyGroup level
s2quake Nov 2, 2025
4196faa
docs: add PR description for XML docs + pack-only config
s2quake Nov 2, 2025
b560d68
docs(xml): disambiguate cref to generic collection types
s2quake Nov 2, 2025
25f3f73
chore(version): bump FileVersion to 1.0.1
s2quake Nov 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

<PropertyGroup>
<AssemblyVersion>1.0</AssemblyVersion>
<FileVersion>1.0.0</FileVersion>
<FileVersion>1.0.1</FileVersion>
<Version>$(FileVersion)</Version>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/s2quake/randora</RepositoryUrl>
Expand Down
23 changes: 23 additions & 0 deletions PR_BODY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Docs: XML IntelliSense + pack-only doc generation

This PR improves developer experience and packaging:

## Summary
- Translate and complete XML documentation for all public APIs in `RandomUtility`, `RandomUtility.Nullable`, and `RandomUtility.Tuple`.
- Enable XML documentation generation only during `dotnet pack` to avoid stray XML outputs in dev builds, while ensuring IntelliSense docs ship in the NuGet package.
- Keep dev builds single-target for faster inner-loop; pack remains multi-target.

## Changes
- docs(random): translate and complete XML docs for RandomUtility, Nullable, and Tuple
- build(pack): condition pack-only settings at PropertyGroup level
- Multi-target only during pack
- Generate XML docs only when packing
- Include .xml in nupkg output

## CI/Release context (existing on main)
- Code coverage collection via coverlet and upload to Codecov (matrix by TFM)
- Test reporting via `dorny/test-reporter` using TRX

## Notes
- No functional code changes; documentation-only plus build configuration for packaging.
- Validated with `dotnet build` and `dotnet pack`; nupkg contains XML docs next to assemblies.
14 changes: 11 additions & 3 deletions src/Directory.Build.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@

<PropertyGroup>
<PublishName>library</PublishName>
<TargetFrameworks Condition="'$(_IsPacking)'=='true'">net6.0;net7.0;net8.0;net9.0;netstandard2.1</TargetFrameworks>
<TargetFramework Condition="'$(_IsPacking)'!='true' and '$(TestFramework)'==''">net9.0</TargetFramework>
<TargetFramework Condition="'$(_IsPacking)'!='true' and '$(TestFramework)'!=''">$(TestFramework)</TargetFramework>
</PropertyGroup>

<PropertyGroup Condition="'$(_IsPacking)'=='true'">
<TargetFrameworks>net6.0;net7.0;net8.0;net9.0;netstandard2.1</TargetFrameworks>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.xml</AllowedOutputExtensionsInPackageBuildOutputFolder>
</PropertyGroup>

<PropertyGroup Condition="'$(_IsPacking)'!='true'">
<TargetFramework Condition="'$(TestFramework)'==''">net9.0</TargetFramework>
<TargetFramework Condition="'$(TestFramework)'!=''">$(TestFramework)</TargetFramework>
</PropertyGroup>

</Project>
Loading