omegaleo/HelperLib
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 19 Wiki Activity

Restructure XmlDocGenerator as MSBuild SDK package for NuGet distribution

Browse Source 
Co-authored-by: omegaleo <5655201+omegaleo@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2026-02-11 22:52:47 +00:00
parent 24383da6fa
commit e0adb2d46b
11 changed files with 127 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files
OmegaLeo.HelperLib.XmlDocGenerator/OmegaLeo.HelperLib.XmlDocGenerator.csproj
+31 -3
View File
@@ -5,13 +5,41 @@
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<PackAsTool>true</PackAsTool>
<ToolCommandName>xmldocgen</ToolCommandName>
<PackAsTool>false</PackAsTool>
<PackageId>OmegaLeo.HelperLib.XmlDocGenerator</PackageId>
<Version>1.0.0</Version>
<Authors>Nuno "Omega Leo" Diogo</Authors>
<Description>MSBuild task to generate XML documentation from DocumentationAttribute</Description>
<PackageProjectUrl>https://github.com/omegaleo/HelperLib</PackageProjectUrl>
<RepositoryUrl>https://github.com/omegaleo/HelperLib</RepositoryUrl>
<PackageLicenseExpression>AGPL-3.0-only</PackageLicenseExpression>
<PackageTags>msbuild;xml;documentation;attributes</PackageTags>
<!-- MSBuild Package Settings -->
<DevelopmentDependency>true</DevelopmentDependency>
<IncludeBuildOutput>false</IncludeBuildOutput>
<NoWarn>NU5100</NoWarn>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="System.Reflection.Metadata" Version="8.0.0" />
<PackageReference Include="System.Reflection.Metadata" Version="8.0.0" PrivateAssets="all" />
</ItemGroup>
<!-- Include the tool exe and its dependencies in the package -->
<Target Name="AddToolToPackage" BeforeTargets="_GetPackageFiles">
<ItemGroup>
<None Include="$(OutputPath)**\*.dll" Pack="true" PackagePath="tools/net8.0/" />
<None Include="$(OutputPath)$(AssemblyName).runtimeconfig.json" Pack="true" PackagePath="tools/net8.0/" />
<None Include="$(OutputPath)$(AssemblyName).deps.json" Pack="true" PackagePath="tools/net8.0/" />
</ItemGroup>
</Target>
<!-- Include build targets in the package -->
<ItemGroup>
<None Include="build\OmegaLeo.HelperLib.XmlDocGenerator.props" Pack="true" PackagePath="build\" />
<None Include="build\OmegaLeo.HelperLib.XmlDocGenerator.targets" Pack="true" PackagePath="build\" />
<None Include="buildMultiTargeting\OmegaLeo.HelperLib.XmlDocGenerator.props" Pack="true" PackagePath="buildMultiTargeting\" />
<None Include="buildMultiTargeting\OmegaLeo.HelperLib.XmlDocGenerator.targets" Pack="true" PackagePath="buildMultiTargeting\" />
</ItemGroup>
</Project>
OmegaLeo.HelperLib.XmlDocGenerator/build/OmegaLeo.HelperLib.XmlDocGenerator.props
+7
View File
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="utf-8"?>
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<!-- Enable XML documentation generation from DocumentationAttribute by default -->
<GenerateXmlDocFromDocumentationAttribute Condition="'$(GenerateXmlDocFromDocumentationAttribute)' == ''">true</GenerateXmlDocFromDocumentationAttribute>
</PropertyGroup>
</Project>
OmegaLeo.HelperLib.XmlDocGenerator/build/OmegaLeo.HelperLib.XmlDocGenerator.targets
+30
View File
@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="utf-8"?>
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<Target Name="GenerateXmlDocFromDocumentationAttribute"
AfterTargets="CoreCompile"
Condition="'$(GenerateXmlDocFromDocumentationAttribute)' == 'true' And '$(TargetFramework)' != ''">
<PropertyGroup>
<!-- Path to the XmlDocGenerator tool in the NuGet package -->
<XmlDocGenToolPath>$(MSBuildThisFileDirectory)..\tools\net8.0\OmegaLeo.HelperLib.XmlDocGenerator.dll</XmlDocGenToolPath>
<TargetAssemblyPath>$(IntermediateOutputPath)$(TargetFileName)</TargetAssemblyPath>
<TargetXmlDocPath>$(IntermediateOutputPath)$(TargetName).xml</TargetXmlDocPath>
</PropertyGroup>
<Message Text="[DocumentationAttribute] Generating XML documentation from DocumentationAttribute for $(TargetName)"
Importance="high"
Condition="Exists('$(XmlDocGenToolPath)') And Exists('$(TargetAssemblyPath)')" />
<Message Text="[DocumentationAttribute] Tool not found at: $(XmlDocGenToolPath)"
Importance="high"
Condition="!Exists('$(XmlDocGenToolPath)')" />
<!-- Run the XmlDocGenerator tool -->
<Exec Command="dotnet &quot;$(XmlDocGenToolPath)&quot; &quot;$(TargetAssemblyPath)&quot; &quot;$(TargetXmlDocPath)&quot;"
Condition="Exists('$(XmlDocGenToolPath)') And Exists('$(TargetAssemblyPath)')"
IgnoreExitCode="true"
ContinueOnError="true" />
</Target>
</Project>
OmegaLeo.HelperLib.XmlDocGenerator/buildMultiTargeting/OmegaLeo.HelperLib.XmlDocGenerator.props
+4
View File
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<Import Project="..\build\OmegaLeo.HelperLib.XmlDocGenerator.props" />
</Project>
OmegaLeo.HelperLib.XmlDocGenerator/buildMultiTargeting/OmegaLeo.HelperLib.XmlDocGenerator.targets
+4
View File
@@ -0,0 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<Import Project="..\build\OmegaLeo.HelperLib.XmlDocGenerator.targets" />
</Project>