Skip to content

Add API documentation generation for the Logging package #4021

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
apoorvdeshmukh merged 6 commits into from
Mar 11, 2026
Merged

Add API documentation generation for the Logging package #4021

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a1c7266
Add api documentation for logging
apoorvdeshmukh Mar 9, 2026
eec8e5f
Merge remote-tracking branch 'origin/main' into dev/ad/api-docs-logging
apoorvdeshmukh Mar 9, 2026
2fa363d
Address review comments
apoorvdeshmukh Mar 9, 2026
d9b8741
Make changes as per doc guidelines
apoorvdeshmukh Mar 9, 2026
d8c8428
Merge remote-tracking branch 'origin/main' into dev/ad/api-docs-logging
apoorvdeshmukh Mar 11, 2026
2e8d69a
Remove unnecessary target to trim xml doc
apoorvdeshmukh Mar 11, 2026
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
38 changes: 34 additions & 4 deletions src/Microsoft.Data.SqlClient.Extensions/Logging/src/Logging.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,12 @@
<!-- The bin/ folder for each target framework. This contains the final build artifacts. -->
<OutputPath>$(Artifacts)/bin/$(Configuration)/$(AssemblyName)</OutputPath>

<!-- We put our docs in the bin/ directory as well. -->
<DocumentationFile>$(Artifacts)/doc/$(TargetFramework)/$(AssemblyName).xml</DocumentationFile>
<!--
Generate XML documentation from /// comments. The compiler places the
XML file alongside the assembly in $(OutputPath). SDK Pack then includes
this file automatically in the NuGet package under lib/<tfm>/.
-->
<GenerateDocumentationFile>true</GenerateDocumentationFile>
Comment thread
apoorvdeshmukh marked this conversation as resolved.

</PropertyGroup>

Expand All @@ -85,7 +89,8 @@
<Title>Microsoft.Data.SqlClient.Extensions.Logging</Title>
<Authors>Microsoft</Authors>
<Company>Microsoft Corporation</Company>
<Description>Microsoft.Data.SqlClient Extensions Logging - ETW EventSource for SqlClient tracing and diagnostics.</Description>
<Description>Microsoft.Data.SqlClient Extensions Logging - ETW EventSource for SqlClient tracing
Comment thread
apoorvdeshmukh marked this conversation as resolved.
Outdated
and diagnostics.</Description>
<Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
<PackageTags>sqlclient microsoft.data.sqlclient extensions logging</PackageTags>
<RepositoryType>git</RepositoryType>
Expand Down Expand Up @@ -115,4 +120,29 @@
</PropertyGroup>
<Import Project="$(ToolsDir)/targets/GenerateThisAssemblyCs.targets" />

</Project>
<!--
Documentation post-processing targets.

After building, we save the full (untrimmed) XML documentation to the
artifacts/doc/ directory for use by public documentation workflows, then
trim the in-place copy (removing <remarks> and <example> nodes) so that
the NuGet package ships a cleaner IntelliSense XML file.
-->
<Target Name="SaveUntrimmedDocs" AfterTargets="Build"
Comment thread
apoorvdeshmukh marked this conversation as resolved.
Outdated
Condition="'$(GenerateDocumentationFile)' == 'true' AND Exists('$(DocumentationFile)')">
<MakeDir Directories="$(Artifacts)/doc/$(TargetFramework)/" />
<Copy SourceFiles="$(DocumentationFile)"
DestinationFolder="$(Artifacts)/doc/$(TargetFramework)/" />
</Target>

<Target Name="TrimDocsForIntelliSense" AfterTargets="SaveUntrimmedDocs"
Comment thread
apoorvdeshmukh marked this conversation as resolved.
Outdated
Condition="'$(GenerateDocumentationFile)' == 'true' AND Exists('$(DocumentationFile)')">
<Exec
Comment thread
apoorvdeshmukh marked this conversation as resolved.
Outdated
Command="powershell.exe -NonInteractive -ExecutionPolicy Unrestricted -Command &quot;$(ToolsDir)intellisense\TrimDocs.ps1 -inputFile '$(DocumentationFile)' -outputFile '$(DocumentationFile)'&quot;"
Condition=" '$(OS)' == 'Windows_NT' " />
<Exec
Command="pwsh -NonInteractive -ExecutionPolicy Unrestricted -Command &quot;$(ToolsDir)intellisense\TrimDocs.ps1 -inputFile '$(DocumentationFile)' -outputFile '$(DocumentationFile)'&quot;"
Condition=" '$(OS)' != 'Windows_NT' " />
</Target>

</Project>
Loading
Loading