Skip to content

v2.0.0

Compare
Choose a tag to compare
@saucecontrol saucecontrol released this 19 Dec 21:14
· 4 commits to master since this release

Breaking Changes

  • Starting with v2.0, InheritDoc requires MSBuild 16.0 or newer. The required version is included with Visual Studio 2019 or later, or any currently supported version of the .NET SDK.

Fixes

  • Fixed an issue that prevented the InheritDoc MSBuild task from being skipped in incremental builds when the compiler's input/output was unchanged. Previously, the input to the task was modified by the task's execution, meaning it would always evaluate as newer than the output. Thanks to @chm-tm for identifying and fixing this #13.
  • Fixed an issue that allowed InheritDoc to run during design-time builds when InheritDocEnabled was explicitly set to true in a consuming project #10.

C# Primary Constructor Improvements

  • InheritDoc now identifies primary constructors by matching documentation between a type and its constructor, and applies fixups to each of the documentation copies.
    • Constructor documentation will now be inherited from a base constructor if present, allowing constructor param elements to be inherited.
    • param elements will be removed from the type's documentation when they are meant to apply to the constructor.