Doraku / DefaultDocumentation

Create a simple markdown documentation from the Visual Studio xml one.
MIT No Attribution
160 stars 26 forks source link

Bump DefaultDocumentation.Api from 1.0.0-beta01 to 1.0.0-beta02 in /source #164

Closed dependabot[bot] closed 4 weeks ago

dependabot[bot] commented 4 weeks ago

Bumps DefaultDocumentation.Api from 1.0.0-beta01 to 1.0.0-beta02.

Release notes

Sourced from DefaultDocumentation.Api's releases.

DefaultDocumentation 1.0.0-beta02

Breaking changes

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

New features

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

Bug fixes

  • fixed string and char const field definition

  • fixed ExplicitInterfaceImplementationsSection config name (fixes #141)

  • fixed StackOverflowException when using cyclic inheritdoc (fixes #142)

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

  • fixed markdown special characters not escaped (fixes #117)

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

  • fixed issue with list rendering

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

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

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

  • api nuget package

  • markdown nuget package

  • msbuild task nuget package

  • dotnet tool nuget package

Commits


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)