Skip to content

Commit 83fa67a

Browse files
committed
chore: update ShellDocs package versions and enable XML documentation generation
- Updated package references in ShellDocs.Site.csproj to version 0.1.6-alpha for all components. - Enabled XML documentation generation by setting GenerateDocumentationFile to true and suppressed CS1591 warnings for missing comments. - Adjusted content inclusion for markdown files to ensure proper copying to output and publish directories.
1 parent 76a2780 commit 83fa67a

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

‎ShellDocs.Site.csproj‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,31 @@
88
<UserSecretsId>shelldocs-site</UserSecretsId>
99
<RootNamespace>ShellDocs.Site</RootNamespace>
1010
<AssemblyName>ShellDocs.Site</AssemblyName>
11+
12+
<!--
13+
AutoTypeTable (added in ShellDocs 0.1.6-alpha) reads XML doc <summary>
14+
comments off registered components' [Parameter] props to fill the
15+
description column. Turning generation on ships a sidecar .xml next to
16+
the .dll so the reflection lookup at render time finds descriptions
17+
instead of em-dashes. CS1591 is "missing XML comment" — noisy while
18+
backfilling docs, keep it suppressed until every prop has one.
19+
-->
20+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
21+
<NoWarn>$(NoWarn);CS1591</NoWarn>
1122
</PropertyGroup>
1223

1324
<ItemGroup>
14-
<PackageReference Include="ShellDocs.Components" Version="0.1.3-alpha" />
15-
<PackageReference Include="ShellDocs.Core" Version="0.1.3-alpha" />
16-
<PackageReference Include="ShellDocs.Markdown" Version="0.1.3-alpha" />
17-
<PackageReference Include="ShellDocs.Tokens" Version="0.1.3-alpha" />
25+
<PackageReference Include="ShellDocs.Components" Version="0.1.6-alpha" />
26+
<PackageReference Include="ShellDocs.Core" Version="0.1.6-alpha" />
27+
<PackageReference Include="ShellDocs.Markdown" Version="0.1.6-alpha" />
28+
<PackageReference Include="ShellDocs.Tokens" Version="0.1.6-alpha" />
1829
</ItemGroup>
1930

2031
<ItemGroup>
21-
<Content Update="content/**/*.md;content/**/meta.json" CopyToOutputDirectory="PreserveNewest" />
32+
<!-- .md isn't auto-included by the Web SDK — Include adds it. -->
33+
<Content Include="content/**/*.md" CopyToOutputDirectory="PreserveNewest" CopyToPublishDirectory="PreserveNewest" />
34+
<!-- .json IS auto-included by the Web SDK — Update just adds the copy metadata. -->
35+
<Content Update="content/**/meta.json" CopyToOutputDirectory="PreserveNewest" CopyToPublishDirectory="PreserveNewest" />
2236
</ItemGroup>
2337

2438
</Project>

0 commit comments

Comments
 (0)