Switch API docs from DefaultDocumentation to ApiMark - #155
Merged
Merged
Conversation
Replace DefaultDocumentation package reference and all associated MSBuild configuration (post-processing UsingTask, custom pack target) with the DemaConsulting.ApiMark.MSBuild package, matching the pattern established in TestResults. - Remove DefaultDocumentation v1.0.2 - Remove PostProcessApiDocs inline C# MSBuild task - Remove PostProcessApiDocsTarget - Remove custom IncludeApiDocsInPackage target - Add DemaConsulting.ApiMark.MSBuild v0.1.3 - Add ApiMark configuration (ApiMarkOutputDir, ApiMarkPackDocs, DisableApiMark) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the build-time API documentation generation setup by switching the project to use DemaConsulting.ApiMark.MSBuild and adding MSBuild properties to control docs output and packing behavior.
Changes:
- Add
DemaConsulting.ApiMark.MSBuildpackage reference to the library project. - Add ApiMark MSBuild properties to control output directory, packing, and multi-targeting behavior.
- Update the local .NET tool manifest entries to include
rollForwardsettings.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/DemaConsulting.SpdxModel/DemaConsulting.SpdxModel.csproj | Adds ApiMark MSBuild package + properties to generate and (conditionally) pack API docs for a single TFM. |
| .config/dotnet-tools.json | Adds rollForward settings to each tool entry in the local tool manifest. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Add <example> blocks to the five members most likely to be reached for first by users and AI coding agents: - Spdx2JsonDeserializer.Deserialize - load from JSON string - Spdx2JsonSerializer.Serialize - save to JSON string - SpdxDocument.Validate - non-obvious List<string> usage pattern - SpdxDocument.GetRootPackages - iterating described packages - SpdxRelationships.Add - adding relationships to a document Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- SpdxDocument.cs: narrow constructor remarks to non-nullable string properties and explicitly note nullable strings (e.g. Comment) remain null unless set - DemaConsulting.SpdxModel.csproj: fix ApiMark conditions so the outer build (empty TargetFramework) is treated as the packaging context — DisableApiMark now only fires for non-empty, non-primary frameworks; ApiMarkPackDocs is true for the empty (outer) build and for the primary TFM
1 task done
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.
Replace DefaultDocumentation package reference and all associated MSBuild configuration (post-processing UsingTask, custom pack target) with the DemaConsulting.ApiMark.MSBuild package, matching the pattern established in TestResults.