Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 1, 2025

Bumps typedoc from 0.25.3 to 0.28.15.

Release notes

Sourced from typedoc's releases.

v0.28.15

Features

  • The gitRevision option now accepts the special value {branch}, which indicates source links should use the current git branch for links, #3041.
  • Introduced validation.invalidPath for suppressing warnings caused by referencing relative paths which do not exist when building the documentation, #3033.
  • API: Introduced Logger.validationWarning for validation which occurs during conversion rather than during TypeDoc's normal validation step, #3033.

v0.28.14

Features

  • Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should be copied to the output documentation, #3020. API: Introduced typeAnnotation on CommentTag
  • Added excludePrivateClassFields option to hide #private members while allowing private members, #3017.
  • Added support for TypeScript's @this tag for JS files which describe this parameters, #3026.

Bug Fixes

  • Fixed conversion of auto-accessor types on properties with the accessor keyword, #3019.
  • Improved handling of HTML tags within headers for anchor generation, #3023.
  • Improved support for detecting destructured parameters and renaming them to the name used in the doc comment, #3026.

v0.28.13

Features

  • The basePath option now also affects relative link resolution, TypeDoc will also check for paths relative to the provided base path. If you instead want TypeDoc to only change the rendered base path for sources, use the displayBasePath option, #3009.

Bug Fixes

  • Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #3007.
  • @inheritDoc will now correctly overwrite @remarks and @returns blocks on the target comment, #3012.
  • The externalSymbolLinkMappings option now works properly on links pointing to inherited/overwritten signatures, #3014.

v0.28.12

Bug Fixes

  • Variables marked with @enum now work for symbols imported from another module, #3003.
  • Improved magic introduced with #2999 to work with imported symbols, #3003.
  • Fixed relative link resolution to file names containing percent encoded URLs, #3006.
  • Linking to the project's README file with a relative link will now behave as expected, #3006.
  • Reduced unnecessary HTML element rendering in default theme.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.28.15 (2025-11-29)

Features

  • The gitRevision option now accepts the special value {branch}, which indicates source links should use the current git branch for links, #3041.
  • Introduced validation.invalidPath for suppressing warnings caused by referencing relative paths which do not exist when building the documentation, #3033.
  • API: Introduced Logger.validationWarning for validation which occurs during conversion rather than during TypeDoc's normal validation step, #3033.

v0.28.14 (2025-10-11)

Features

  • Introduced the preservedTypeAnnotationTags option to specify tags whose type annotations should be copied to the output documentation, #3020. API: Introduced typeAnnotation on CommentTag
  • Added excludePrivateClassFields option to hide #private members while allowing private members, #3017.
  • Added support for TypeScript's @this tag for JS files which describe this parameters, #3026.
  • API: Re-introduced relevanceBoost on DeclarationReflection for plugin use, #3036.

Bug Fixes

  • Fixed conversion of auto-accessor types on properties with the accessor keyword, #3019.
  • Improved handling of HTML tags within headers for anchor generation, #3023.
  • Improved support for detecting destructured parameters and renaming them to the name used in the doc comment, #3026.
  • Constructor type parameters will now inherit their class's type parameter descriptions if not otherwise specified, #3031.
  • Fixed compatibility with @microsoft/tsdoc-config version 0.18.0, #3035.
  • Custom theme icons will now be used in the "On This Page" sidebar, #3039.

Thanks!

v0.28.13 (2025-09-14)

Features

  • The basePath option now also affects relative link resolution, TypeDoc will also check for paths relative to the provided base path. If you instead want TypeDoc to only change the rendered base path for sources, use the displayBasePath option, #3009.

Bug Fixes

  • Fixed bug introduced in 0.28.8 where TypeDoc could not render docs with some mixin classes, #3007.
  • @inheritDoc will now correctly overwrite @remarks and @returns blocks on the target comment, #3012.
  • The externalSymbolLinkMappings option now works properly on links pointing to inherited/overwritten signatures, #3014.

... (truncated)

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 <dependency name> 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)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.3 to 0.28.15.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.3...v0.28.15)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-version: 0.28.15
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Dec 1, 2025
@dependabot dependabot bot requested a review from a team as a code owner December 1, 2025 16:00
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Dec 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code

Development

Successfully merging this pull request may close these issues.

1 participant