SauceControl.InheritDoc 2.0.1

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved

Requires NuGet 5.0 or higher.

dotnet add package SauceControl.InheritDoc --version 2.0.1
NuGet\Install-Package SauceControl.InheritDoc -Version 2.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SauceControl.InheritDoc" Version="2.0.1">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SauceControl.InheritDoc --version 2.0.1
#r "nuget: SauceControl.InheritDoc, 2.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SauceControl.InheritDoc as a Cake Addin
#addin nuget:?package=SauceControl.InheritDoc&version=2.0.1

// Install SauceControl.InheritDoc as a Cake Tool
#tool nuget:?package=SauceControl.InheritDoc&version=2.0.1

InheritDoc

This MSBuild Task automatically replaces <inheritdoc /> tags in your .NET XML documentation with the actual inherited docs.

How to Use It

  1. Add some <inheritdoc /> tags to your XML documentation comments.

    This tool’s handling of <inheritdoc /> tags is based on the design document used for Roslyn's support in Visual Studio, which is in turn based on the <inheritdoc /> support in Sandcastle Help File Builder (SHFB).

  2. Add the SauceControl.InheritDoc NuGet package reference to your project.

    This is a development-only dependency; it will not be deployed with or referenced by your compiled app/library.

  3. Build your project as you normally would.

    The XML docs will be post-processed automatically with each non-debug build, whether you use Visual Studio, dotnet CLI, or anything else that hosts the MSBuild engine.

Additional Features

  • Updates the contents of inherited docs to replace param and typeparam names that changed in the inheriting type or member.

  • Supports trimming your published XML doc files of any types or members not publicly visible in your API.

  • Validates your usage of <inheritdoc /> and warns you if no documentation exists or if your crefs or paths are incorrect.

For more details and examples, see the project home page

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on SauceControl.InheritDoc:

Package Downloads
PixelatedLabs.Standard

Common static analysis configuration for .NET projects.

GitHub repositories (7)

Showing the top 5 popular GitHub repositories that depend on SauceControl.InheritDoc:

Repository Stars
nodatime/nodatime
A better date and time API for .NET
TestableIO/System.IO.Abstractions
Just like System.Web.Abstractions, but for System.IO. Yay for testable IO access!
json-api-dotnet/JsonApiDotNetCore
A framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core.
saucecontrol/PhotoSauce
MagicScaler high-performance, high-quality image processing pipeline for .NET
atata-framework/atata
C#/.NET test automation framework for web
Version Downloads Last updated
2.0.1 18,248 2/8/2024
2.0.0 13,966 12/19/2023
1.4.0 13,703 11/26/2023
1.3.0 352,270 5/7/2021
1.2.0 1,055,138 12/9/2020
1.1.1 7,030 11/14/2020
1.0.0 47,474 2/16/2020
0.4.0 4,448 10/24/2019
0.3.0 839 10/4/2019
0.2.0 504 9/30/2019
0.1.0 731 9/27/2019

See https://github.com/saucecontrol/InheritDoc/releases for release-specific notes.