Skip to content

Bump xmldoc2markdown from 5.0.0 to 6.0.0 - #66

Closed
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/nuget/dot-config/xmldoc2markdown-6.0.0
Closed

Bump xmldoc2markdown from 5.0.0 to 6.0.0#66
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/nuget/dot-config/xmldoc2markdown-6.0.0

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Sep 6, 2026

Copy link
Copy Markdown
Contributor

Updated xmldoc2markdown from 5.0.0 to 6.0.0.

Release notes

Sourced from xmldoc2markdown's releases.

6.0.0

Added

  • Target-platform presets --platform <plain|github-pages|jekyll|gitlab-wiki|just-the-docs|docusaurus> with per-knob overrides --link-extension and --link-prefix. #​22
  • YAML front matter emission via --front-matter <none|jekyll|just-the-docs|docusaurus>, with extra static keys via repeatable --front-matter-field key=value. #​36
  • <inheritdoc/> expansion — merges documentation from the inheritance source, with cycle protection and per-param/typeparam/exception matching. #​41
  • Records recognised — record class and readonly record struct on the type signature; compiler-synthesised members filtered out. #​39
  • Generic constraints (where T : …) rendered after the parameter list for types and methods.
  • Method virtuality emitted: virtual, override, sealed override, and best-effort new.
  • Default and static abstract interface members rendered with canonical C# modifiers.
  • Parameter modifiers (ref, in, out, params) and default values in signatures and per-parameter prose.
  • Nullable reference types (string?, IEnumerable<string?>?, etc.) via NullabilityInfoContext; Nullable<T> collapsed to T?.
  • Tuples render as (int X, string Y) instead of ValueTuple<int, string>.
  • async modifier emitted on method signatures.
  • init accessor replaces set; on init-only properties.
  • Enum underlying types shown when they differ from int (e.g. public enum MyByteEnum : byte).
  • required modifier emitted on fields and properties.
  • readonly struct and ref struct keywords rendered on type signatures.
  • Operators documented in their own section (operator +, implicit operator T, etc.).
  • Indexers render as this[T index] in their own Indexers section.

Performance

  • Performance improvements.

Fixes

  • Nested public types (IsNestedPublic) were not documented.
  • Partially loadable assemblies no longer crash the run; ReflectionTypeLoadException falls back to ex.Types with a warning.
  • cref parameter counting corrected: Foo() counted as zero params; generic arguments with commas no longer over-counted.
  • Enum field tables tolerate | in summaries — escaped as &#​124;.
  • MemberTypesAliases reverse lookups now return the correct general member type.
  • Output directory is created up front even when no types successfully render.
  • Generic-type crefs (e.g. Dictionary{TKey,TValue}) now resolve to working links.
  • Self-closing <see cref="..."/> no longer renders as empty — falls back to the parsed display name.
  • Non-public members are now resolved by cref lookups.
  • Unresolvable cref fallback uses inline code instead of plain text.
  • Nested-type crefs now produce working links (CLR + nesting vs XML . separator). #​31
  • Members referencing unresolvable external types no longer drop the entire type page; the member renders as a name-only heading with a warning. #​40
  • External Microsoft-owned types (System.*, Microsoft.*, Windows.*) now link to MS Learn. #​42
  • MS docs links migrated from docs.microsoft.com to learn.microsoft.com.

Breaking changes

  • --github-pages and --gitlab-wiki options removed — migrate to --platform github-pages / --platform gitlab-wiki.

Commits viewable in compare view.

@dependabot dependabot Bot added .NET Pull requests that update .NET code dependencies Dependency updates labels Sep 6, 2026
---
updated-dependencies:
- dependency-name: xmldoc2markdown
  dependency-version: 6.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@skuirrels

Copy link
Copy Markdown
Owner

Merged via #68, which cherry-picked this commit onto the current main so the three bumps could pass branch protection in one CI round.

@skuirrels skuirrels closed this Sep 6, 2026
@dependabot @github

dependabot Bot commented on behalf of github Sep 6, 2026

Copy link
Copy Markdown
Contributor Author

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@dependabot
dependabot Bot deleted the dependabot/nuget/dot-config/xmldoc2markdown-6.0.0 branch September 6, 2026 16:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Dependency updates .NET Pull requests that update .NET code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant