InheritDoc 1.0.0.299

Command line tool that post processes XML documentation files to support an <inheritdoc/> tag allowing inheriting XML comments from base types, interfaces, and similar methods.

There is a newer version of this package available.
See the version list below for details.
Install-Package InheritDoc -Version 1.0.0.299
dotnet add package InheritDoc --version 1.0.0.299
<PackageReference Include="InheritDoc" Version="1.0.0.299" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add InheritDoc --version 1.0.0.299
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Allows adding <inheritdoc/> tags to XML comments in C# source code to inherit XML comments from base classes, interfaces, and similar methods. This eliminates unwanted copying and pasting of duplicate XML comments and automatically keeps XML comments synchronized.

XML comments (starting with ///) are compiled into XML documentation files for each assembly by the normal build process. InheritDoc post processes these XML documentation files to inherit XML comments as needed. This approach makes the XML comments compatible with other documentation tools, accessible by Intellisense, and packagable into a Nuget package if distributing a library.

Installing

Install-Package InheritDoc

Details

See www.inheritdoc.io for more details

Allows adding <inheritdoc/> tags to XML comments in C# source code to inherit XML comments from base classes, interfaces, and similar methods. This eliminates unwanted copying and pasting of duplicate XML comments and automatically keeps XML comments synchronized.

XML comments (starting with ///) are compiled into XML documentation files for each assembly by the normal build process. InheritDoc post processes these XML documentation files to inherit XML comments as needed. This approach makes the XML comments compatible with other documentation tools, accessible by Intellisense, and packagable into a Nuget package if distributing a library.

Installing

Install-Package InheritDoc

Details

See www.inheritdoc.io for more details

Release Notes

Initial release

Dependencies

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on InheritDoc:

Repository Stars
Chris3606/GoRogue
.NET Standard roguelike library in C#. Features many algorithms and data structures pertinent to roguelike/2D game developers, specifically designed to be minimally intrusive upon the developer's architecture.

Version History

Version Downloads Last updated
2.5.2 2,101 3/18/2020
2.5.1 3,205 2/1/2020
2.5.0 160 1/27/2020
2.4.1 287 1/17/2020
2.4.0 146 1/17/2020
2.3.0 7,979 8/28/2019
2.2.1 1,243 5/23/2019
2.2.0 785 5/2/2019
2.1.0 305 5/1/2019
2.0.2 4,376 10/23/2018
2.0.1 402 10/23/2018
2.0.0 605 8/23/2018
1.2.3 414 8/21/2018
1.2.2.1 1,110 8/12/2018
1.2.1.1 452 8/5/2018
1.2.0.1 1,369 7/15/2018
1.1.1.1 3,513 6/5/2018
1.1.0.1 630 5/9/2018
1.0.8.1 574 2/15/2018
1.0.7.1 562 1/25/2018
1.0.6.1 495 1/25/2018
1.0.5.1 547 1/25/2018
1.0.4.1 516 1/19/2018
1.0.3.2 487 1/19/2018
1.0.2.1 563 1/3/2018
1.0.0.342 550 1/2/2018
1.0.0.308 518 12/20/2017
1.0.0.307 546 12/20/2017
1.0.0.299 625 12/18/2017
Show less