Skip to content

Commit 3922ef5

Browse files
committed
Include Common and xml docs on site
1 parent c0b1e3c commit 3922ef5

File tree

4 files changed

+53
-48
lines changed

4 files changed

+53
-48
lines changed

ChartTools/ChartTools.Generator/MetadataMapGenerator.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
using Microsoft.CodeAnalysis;
44
using Microsoft.CodeAnalysis.CSharp.Syntax;
55

6-
using System;
76
using System.Collections.Generic;
87
using System.Collections.Immutable;
98
using System.Diagnostics;
@@ -12,6 +11,9 @@
1211

1312
namespace ChartTools.Generator;
1413

14+
/// <summary>
15+
/// Generates mapping methods between <see cref="Metadata"/> properties and their corresponding keys in different file formats, as defined by <see cref="MetadataKeyAttribute"/>
16+
/// </summary>
1517
[Generator]
1618
public class MetadataMapGenerator : IIncrementalGenerator
1719
{
Lines changed: 47 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,55 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22

3-
<PropertyGroup>
4-
<TargetFrameworks>netstandard2.0;netstandard2.1;net8.0;net9.0;net10.0</TargetFrameworks>
5-
<LangVersion>14.0</LangVersion>
6-
<ImplicitUsings>enable</ImplicitUsings>
7-
<Nullable>enable</Nullable>
8-
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
9-
<GenerateDocumentationFile>True</GenerateDocumentationFile>
10-
<SignAssembly>False</SignAssembly>
11-
<Description>Library for editing Clone Hero song files in .NET</Description>
12-
<PackageProjectUrl></PackageProjectUrl>
13-
<PackageReadmeFile>README.md</PackageReadmeFile>
14-
<PackageLicenseFile>LICENSE</PackageLicenseFile>
15-
<RepositoryUrl>https://github.com/TheBoxyBear/charttools</RepositoryUrl>
16-
<NeutralLanguage>en-CA</NeutralLanguage>
17-
<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
18-
<Company>TheBoxyBear</Company>
19-
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
20-
<RunPostBuildEvent>OnOutputUpdated</RunPostBuildEvent>
21-
</PropertyGroup>
3+
<PropertyGroup>
4+
<TargetFrameworks>netstandard2.0;netstandard2.1;net8.0;net9.0;net10.0</TargetFrameworks>
5+
<LangVersion>14.0</LangVersion>
6+
<ImplicitUsings>enable</ImplicitUsings>
7+
<Nullable>enable</Nullable>
8+
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
9+
<GenerateDocumentationFile>True</GenerateDocumentationFile>
10+
<SignAssembly>False</SignAssembly>
11+
<Description>Library for editing Clone Hero song files in .NET</Description>
12+
<PackageProjectUrl></PackageProjectUrl>
13+
<PackageReadmeFile>README.md</PackageReadmeFile>
14+
<PackageLicenseFile>LICENSE</PackageLicenseFile>
15+
<RepositoryUrl>https://github.com/TheBoxyBear/charttools</RepositoryUrl>
16+
<NeutralLanguage>en-CA</NeutralLanguage>
17+
<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
18+
<Company>TheBoxyBear</Company>
19+
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
20+
<RunPostBuildEvent>OnOutputUpdated</RunPostBuildEvent>
21+
</PropertyGroup>
2222

23-
<ItemGroup>
24-
<None Include="..\..\LICENSE">
25-
<Pack>True</Pack>
26-
<PackagePath>\</PackagePath>
27-
</None>
28-
<None Include="..\..\README.md">
29-
<Pack>True</Pack>
30-
<PackagePath>\</PackagePath>
31-
</None>
32-
</ItemGroup>
23+
<ItemGroup>
24+
<None Include="..\..\LICENSE">
25+
<Pack>True</Pack>
26+
<PackagePath>\</PackagePath>
27+
</None>
28+
<None Include="..\..\README.md">
29+
<Pack>True</Pack>
30+
<PackagePath>\</PackagePath>
31+
</None>
32+
</ItemGroup>
3333

34-
<ItemGroup>
35-
<ProjectReference Include="..\ChartTools.Common\ChartTools.Common.csproj" />
36-
<ProjectReference Include="..\ChartTools.Generator\ChartTools.Generator.csproj" OutputItemType="Analyzer" />
37-
</ItemGroup>
34+
<ItemGroup>
35+
<ProjectReference Include="..\ChartTools.Common\ChartTools.Common.csproj" />
36+
<ProjectReference Include="..\ChartTools.Generator\ChartTools.Generator.csproj" OutputItemType="Analyzer" />
37+
</ItemGroup>
3838

39-
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0' Or '$(TargetFramework)' == 'netstandard2.1'">
40-
<Reference Include="Bcl.CollectionsMarshal">
41-
<HintPath>..\Dependencies\bin\$(TargetFramework)\Bcl.CollectionsMarshal.dll</HintPath>
42-
</Reference>
43-
</ItemGroup>
39+
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0' Or '$(TargetFramework)' == 'netstandard2.1'">
40+
<Reference Include="Bcl.CollectionsMarshal">
41+
<HintPath>..\Dependencies\bin\$(TargetFramework)\Bcl.CollectionsMarshal.dll</HintPath>
42+
</Reference>
43+
</ItemGroup>
4444

45-
<Target Name="CopyDataFiles" AfterTargets="PostBuildEvent">
46-
<ItemGroup>
47-
<DataFiles Include="$(OutDir)ChartTools.dll" />
48-
</ItemGroup>
49-
<Copy SourceFiles="@(DataFiles)" DestinationFolder="$(ProjectDir)artifacts" SkipUnchangedFiles="true" />
50-
</Target>
45+
<Target Name="CopyDataFiles" AfterTargets="PostBuildEvent">
46+
<ItemGroup>
47+
<Files Include="$(OutDir)ChartTools*.dll;$(OutDir)ChartTools*.xml"/>
48+
</ItemGroup>
49+
<Copy
50+
SourceFiles="@(Files)"
51+
DestinationFolder="$(ProjectDir)artifacts"
52+
SkipUnchangedFiles="true" />
53+
</Target>
5154

5255
</Project>

ChartTools/Docs/Docs.csproj

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
</ItemGroup>
2121

2222
<ItemGroup>
23-
<PackageReference Include="Docfx.App" Version="2.78.4" />
24-
<PackageReference Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="4.14.0" />
23+
<PackageReference Include="Docfx.App" Version="2.78.5" />
24+
<PackageReference Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="5.0.0" />
2525
</ItemGroup>
2626

2727
<ProjectExtensions><VisualStudio><UserProperties /></VisualStudio></ProjectExtensions>

ChartTools/Docs/docfx.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
{
66
"src": "../ChartTools",
77
"files": [
8-
"artifacts/ChartTools.dll"
8+
"artifacts/*.dll"
99
]
1010
}
1111
],

0 commit comments

Comments
 (0)