Skip to content

Releases: Doraku/DefaultDocumentation

DefaultDocumentation 1.1.1

13 Jun 16:10
Compare
Choose a tag to compare

Bug fixes

DefaultDocumentation 1.1.0

02 Jun 17:13
Compare
Choose a tag to compare

New features

DefaultDocumentation 1.0.2

31 May 16:48
Compare
Choose a tag to compare

Bug fixes

DefaultDocumentation 1.0.1

30 May 21:51
Compare
Choose a tag to compare

Bug fixes

DefaultDocumentation 1.0.0

29 May 12:33
Compare
Choose a tag to compare

Breaking changes

  • renamed Markdown.IgnoreLineBreak setting to Markdown.HandleLineBreak to change default behavior (#122)

New features

  • added DefaultDocumentation.GeneratedAccessModifiers.Api which regroup Public, Protected and InternalProtected access modifiers (#116)
  • added support for record
  • elements, url factories, file name factory and sections are now case insensitive in configuration (#157)
  • it is now possible to change the format of url link procuded in the markdown via Markdown.UrlFormat configuration (#107)
  • added IDocItemGenerator to customize pages generated
  • added OverloadsGenerator to put constructor and method overloads in the same page (#139)
  • added ExcludeGenerator to exclude DocItem from the documentation generation based on regex (#160)
  • list code and note elements now display a placeholder value ... when displayed as a single line
  • added DirectoryName IFileNameFactory implementation (#104)
  • added some settings validation for better error message (#154)

Bug fixes

  • fixed string and char const field definition

  • fixed ExplicitInterfaceImplementationsSection config name (#141)

  • fixed StackOverflowException when using cyclic inheritdoc (#142)

  • fixed property getter/setter access modifier not taken into account (#151)

  • fixed markdown special characters not escaped (#117)

  • fixed unhandled xml elements not rendering as is in markdown (#126)

  • fixed issue with list rendering

  • fixed enum fields to respect code order (#131)

  • fixed c and see elements with leading and trailing linebreak chars (#113)

  • fixed plugins loading in certain context (#145 thanks to @a10r)

  • fixed edge case for missing types for explicit interface implementation (#167)

  • api nuget package

  • markdown nuget package

  • msbuild task nuget package

  • dotnet tool nuget package

DefaultDocumentation 0.8.2

12 Jun 12:18
Compare
Choose a tag to compare

Bug fixes

  • fixed cmd usage with default markdown plugin loading (#109 thanks to @aremes)

api nuget package
msbuild task nuget package
dotnet tool nuget package

DefaultDocumentation 0.8.1

01 May 10:01
Compare
Choose a tag to compare

Bug fixes

  • fixed documentation generation for vbproject (#106 thanks to @bwood4)

api nuget package
msbuild task nuget package
dotnet tool nuget package

DefaultDocumentation 0.8.0

19 Mar 13:41
Compare
Choose a tag to compare

Breaking changes

  • lot of argument/property changes, please check readme for more informations

New features

  • added support for plugins (#4, #79)
  • added support for list (type bullet, number or table) elements (#44 thanks to @IdkGoodName)
  • added event explicit interface implementation support
  • added support for external json configuration file (#84)
  • added TableOfContents section (#82)
  • added Footer section

Fixes

  • fixed nested types in generated types and empty namespace showing when using IncludeUndocumentedItems (thanks to @hairlesshobo)
  • fixed some markdown formating (#93)

api nuget package
msbuild task nuget package
dotnet tool nuget package

DefaultDocumentation 0.7.9

26 Sep 19:15
Compare
Choose a tag to compare

added DefaultDocumentationIncludeUndocumentedItems property / IncludeUndocumentatedItems arg to include types and members with no documentation (#81)


fixed mutex creation on linux (#80)

msbuild task nuget package
dotnet tool nuget package

DefaultDocumentation 0.7.7

11 Sep 14:36
Compare
Choose a tag to compare

added logging (#69)


fixed accessibility check of nested types
fixed generation of nested types when declaring types are excluded
fixed multiple DefaultDocumentation running with multiple TargetFrameworks
fixed msbuild task not used in csproj with old format
fixed ignorelinebreak attribute detection

msbuild task nuget package
dotnet tool nuget package