Skip to content

Releases: adamecr/MarkupDoc

Patch 2.0.3

22 Jan 12:36
Compare
Choose a tag to compare

Added

  • Added support for <NuProp.Remarks cref=""> documentation comment (reference to type to get the XML Documentation remarks from to document the source only package).

Changed

  • Updated Microsoft.Build.Locator package version

Patch 2.0.2

30 Dec 09:53
Compare
Choose a tag to compare

Fixed

  • Relative paths to source files from source-only packages corrected in output
  • Fixed Extension returned by MarkdownMarkupProvider

Patch 2.0.1

29 Dec 14:38
Compare
Choose a tag to compare

Changed

  • Output generator add-on instances are created automatically.
  • Own code documentation is split by namespace

v2.0.0

23 Dec 17:01
Compare
Choose a tag to compare

Added

  • Added <see langword="xxxx" /> support.
  • Added information about source file(s) in the header of type and type members documentation.
  • Added information (and link if available) about overriden Method, Property or Event.
  • Added information (and link if available) about implemented interface Method, Property or Event.
  • Added information about directly derived types (Derived: ...). Note: only the types existing in project being documented are displayed here.
  • Added information about types implementing the interface (Implemented by: ...). Note: only the types existing in project being documented are displayed here.
  • Added information about Explicit Interface Implementations (section in a type page). Note: explicit interface implementation members are listed both in the event/propery/method table as well as in Explicit Interface Implementations table.
  • Added <inheritdoc /> support.
  • Added Output generator add-ons functionality.

Changed

  • XML Documentation parsing error is not a blocker anymore, the warning is displayed in console.
  • Improved exception presentation within console.

Fixed

  • Issue #1: Method title shown correctly (there has been a constant "Title" instead of variable title used).

Deprecated

  • MarkupGenerator.WritePageFooter has been replaced by MarkupGenerator.WritePageFooterAsync. The functionality remains the same, just the name of the method has been corrected. WritePageFooter will be removed in version 3.x.x.
  • MarkupGenerator.Split has been replaced by MarkupGenerator.SplitAsync. The functionality remains the same, just the name of the method has been corrected. Split will be removed in version 3.x.x.

Breaking changes

  • IMarkupProvider has been extended with public string Extension property.

Initial release

02 Dec 16:49
Compare
Choose a tag to compare
v1.0.0

v1.0.0