dotMorten/XmlDocStripTask

Optimizes your xml documentation for intellisense by stripping out internal documentation and remarks.

★ 6Forks 1C#GitHub ↗Compare

README

XmlDocStripTask

Optimizes your xml documentation for intellisense by stripping out internal documentation and remarks.

Simply add the nuget package dotMorten.XmlDocStripTask and build. If your project has XML documentation, the xml doc file will be reduced by excluding all internal members and optionally the remarks sections. Use this to distribute with your assemblies instead, reducing the size of your packages and increase intellisense load times.

Usage

Add the following to your project file, and you're done:

  <ItemGroup>
      <PackageReference Include="dotMorten.XmlDocStripTask" PrivateAssets="all" Version="1.1.1" />
  </ItemGroup>

Optional settings:

  <PropertyGroup>
     <!-- Don't overwrite the xml doc but write the stripped version to a different file -->
    <XmlDocStripOutputPath>PathToStrippedFile.xml</XmlDocStripOutputPath>
    <!-- Also strip remarks -->
    <StripXmlRemarks>true</StripXmlRemarks>
  </PropertyGroup>

Nuget Package:

https://www.nuget.org/packages/dotMorten.XmlDocStripTask

Contributors

dotMorten

Issues