SauceControl.InheritDoc 1.3.0

Prefix Reserved
There is a newer version of this package available.
See the version list below for details. 
dotnet add package SauceControl.InheritDoc --version 1.3.0
                    


                    

                
NuGet\Install-Package SauceControl.InheritDoc -Version 1.3.0
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="1.3.0">
  <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. 
<PackageVersion Include="SauceControl.InheritDoc" Version="1.3.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SauceControl.InheritDoc">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add SauceControl.InheritDoc --version 1.3.0
                    


                    

                
#r "nuget: SauceControl.InheritDoc, 1.3.0"
#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. 
#:package SauceControl.InheritDoc@1.3.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=SauceControl.InheritDoc&version=1.3.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SauceControl.InheritDoc&version=1.3.0
                    


                            Install as a Cake Tool

This MSBuild Task automatically replaces inheritdoc tags in your .NET XML documentation with the actual inherited docs. By integrating with MSBuild, this tool has access to the exact arguments passed to the compiler -- including all assembly references -- making it both simpler and more capable than other documentation post-processing tools. As it processes inheritdoc elements, it is able to accurately resolve base types whether they come from the target framework, referenced NuGet packages, or project references. This means it can intelligently map documentation from base types and members to yours. For example, it can identify when you change the name of a method parameter from the base type’s definition and update the documentation accordingly. It can also remove documentation for non-public types/members to reduce the size of your published XML 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 draft design document used for the new prototype Roslyn support, 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.

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 (12)

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

Repository Stars
Azure/azure-sdk-for-net
This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
nodatime/nodatime
A better date and time API for .NET
saucecontrol/PhotoSauce
MagicScaler high-performance, high-quality image processing pipeline for .NET
json-api-dotnet/JsonApiDotNetCore
A framework for building JSON:API compliant REST APIs using ASP.NET and Entity Framework Core.
atata-framework/atata
C#/.NET test automation framework for web
chickensoft-games/LogicBlocks
Human-friendly, hierarchical and serializable state machines for games and apps in C#.
qdrant/qdrant-dotnet
Qdrant .Net SDK
Liu233w/acm-statistics
Note: The website is rewritten in https://github.com/Liu233w/ojhunt-lite
z4kn4fein/stashbox
A lightweight, fast, and portable dependency injection framework for .NET-based solutions.
chickensoft-games/GoDotTest
C# test runner for Godot. Run tests from the command line, collect code coverage, and debug tests.
saucecontrol/Blake2Fast
Optimized BLAKE2 hashing implementations in C#
dmester/pdftosvg.net
Fully managed .NET library for converting PDF files to SVG.
Version Downloads Last Updated
2.0.2 370,173 10/12/2024
2.0.1 191,357 2/8/2024
2.0.0 22,689 12/19/2023
1.4.0 29,028 11/26/2023
1.3.0 473,793 5/7/2021
1.2.0 1,552,071 12/9/2020
1.1.1 7,525 11/14/2020
1.0.0 53,369 2/16/2020
0.4.0 4,856 10/24/2019
0.3.0 1,097 10/4/2019
0.2.0 801 9/30/2019
0.1.0 1,769 9/27/2019

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