Include XML documentation files in NuGet packages for IntelliSense#139
Open
xiaomi7732 wants to merge 1 commit into
Open
Include XML documentation files in NuGet packages for IntelliSense#139xiaomi7732 wants to merge 1 commit into
xiaomi7732 wants to merge 1 commit into
Conversation
Enable GenerateDocumentationFile in Directory.Build.props for both the OTel and classic profiler trees, and add corresponding XML file entries to all three nuspec files so the generated docs ship inside the NuGet packages. Add missing XML doc comment on OpenTelemetryBuilderExtensions class to resolve CS1591 warning. Fixes Azure#85 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
1 participant
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.
Fixes #85
Problem
The NuGet packages (
Azure.Monitor.OpenTelemetry.ProfilerandMicrosoft.ApplicationInsights.Profiler.AspNetCore/Core) do not include XML documentation files, so consumers have no IntelliSense or IDE documentation for public APIs.Changes
Directory.Build.props(both OTel and classic profiler trees) — Added<GenerateDocumentationFile>true</GenerateDocumentationFile>so all projects generate XML doc files during build.*.xmlor explicit.xml) alongside existing DLL/PDB entries so the generated docs ship inside the NuGet packages.OpenTelemetryBuilderExtensions.cs— Added missing<summary>XML doc comment on the class to resolve the CS1591 warning introduced by enabling doc generation.Verification