Skip to content

Commit 3f9246c

Browse files
apoorvdeshmukhapoorvdeshmukh
authored
Add API documentation generation for the Logging package (#4021)
This commit enhances the api documentation for logging package and adds documentation xml file to the logging nuget package. Since the current nuget package does not contain the ref dir for trimmed documentation file for intellisense, only the untrimmed xml documentation exists in the lib dir.
1 parent e970f4d commit 3f9246c

File tree

2 files changed

+612
-26
lines changed

2 files changed

+612
-26
lines changed

‎src/Microsoft.Data.SqlClient.Extensions/Logging/src/Logging.csproj‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,12 @@
6565
<!-- The bin/ folder for each target framework. This contains the final build artifacts. -->
6666
<OutputPath>$(Artifacts)/bin/$(Configuration)/$(AssemblyName)</OutputPath>
6767

68-
<!-- We put our docs in the bin/ directory as well. -->
69-
<DocumentationFile>$(Artifacts)/doc/$(TargetFramework)/$(AssemblyName).xml</DocumentationFile>
68+
<!--
69+
Generate XML documentation from /// comments. The compiler places the
70+
XML file alongside the assembly in $(OutputPath). SDK Pack then includes
71+
this file automatically in the NuGet package under lib/<tfm>/.
72+
-->
73+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
7074

7175
</PropertyGroup>
7276

@@ -85,7 +89,10 @@
8589
<Title>Microsoft.Data.SqlClient.Extensions.Logging</Title>
8690
<Authors>Microsoft</Authors>
8791
<Company>Microsoft Corporation</Company>
88-
<Description>Microsoft.Data.SqlClient Extensions Logging - ETW EventSource for SqlClient tracing and diagnostics.</Description>
92+
<Description>
93+
Microsoft.Data.SqlClient Extensions Logging - ETW EventSource for SqlClient tracing
94+
and diagnostics.
95+
</Description>
8996
<Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
9097
<PackageTags>sqlclient microsoft.data.sqlclient extensions logging</PackageTags>
9198
<RepositoryType>git</RepositoryType>
@@ -115,4 +122,4 @@
115122
</PropertyGroup>
116123
<Import Project="$(ToolsDir)/targets/GenerateThisAssemblyCs.targets" />
117124

118-
</Project>
125+
</Project>

0 commit comments

Comments
 (0)