Giter Site home page Giter Site logo

xmldocstriptask's Introduction

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

xmldocstriptask's People

Contributors

dotmorten avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

fredatgithub

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.