Skip to content

Releases: TypeStrong/typedoc

v0.28.19

Choose a tag to compare

@github-actions github-actions released this 12 Apr 01:36

Features

  • Added French translations for the TypeDoc interface and help descriptions.
  • Added support for triple-slash comment style, which requires exactly three slashes in the comment, #3089.

Bug Fixes

  • Corrected handling of icon caching for custom themes which use SVGs with a larger view box than TypeDoc's default theme.
  • Fixed short summary comment handling on module pages when the project source files use Windows line endings, #3093.

Thanks!

v0.28.18

Choose a tag to compare

@github-actions github-actions released this 23 Mar 03:45

Features

  • Support TypeScript 6.0, #3084.

v0.28.17

Choose a tag to compare

@github-actions github-actions released this 13 Feb 18:12

Bug Fixes

  • Improved handling of comments for type aliases which have been declaration merged with functions, #3064.
  • Fixed anchor link generation to members named $, #3065.
  • Corrected typing of the plugin option to permit functions, #3066.
  • Warnings about unused @param tags will now be properly suppressed when they come from declaration files and
    the suppressCommentWarningsInDeclarationFiles option is enabled, #3070.
  • Fixed conversion of types referencing type parameters on functions, #3071.

Thanks!

v0.28.16

Choose a tag to compare

@github-actions github-actions released this 12 Jan 00:23

Bug Fixes

  • Fixed an issue causing TypeDoc to fail to generate documentation when implementing interfaces, #3052.
  • Fixed an issue preventing automatic entry point discovery on Windows, #3057.
  • Improved vertical positioning of text icons, #3056.
  • TypeDoc no longer includes source location information for type literal reflections. This could sometimes
    cause TypeDoc to infer the wrong path when resolving base paths for display.
  • Adjusted markdown rendering to allow markdownItLoader to override more rendering #3055.

Features

  • Added support for regions for @include in .tsx, .cjs, and .mjs file references #3048.
  • Comments for TS-in-JS @typedef tags may now specify modifier tags with the inline tag syntax {@mod}.
    This makes it possible to add modifier tags to these members, which previously was not possible as
    TypeScript's parsing stops for these members at the next non-braced tag, #2916 and #3050.
  • A typedoc-config.schema.json is now included in the root of the package with a JSON schema for TypeDoc's
    configuration file. The schema for the latest version is also published at https://typedoc.org/schema.json
    and will automatically be picked up when writing typedoc.json files if you are using VSCode, #3054.

Thanks!

v0.28.15

Choose a tag to compare

@github-actions github-actions released this 29 Nov 04:56

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

Choose a tag to compare

@github-actions github-actions released this 11 Oct 04:26

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

Choose a tag to compare

@github-actions github-actions released this 14 Sep 23:48

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

Choose a tag to compare

@github-actions github-actions released this 01 Sep 02:37

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.
    API: Reflection.hasComment and Comment.hasVisibleComponent now accepts an optional notRenderedTags parameter.

v0.28.11

Choose a tag to compare

@github-actions github-actions released this 25 Aug 03:13

Features

  • Object properties declared with shorthand property assignment will now use the variable's comment
    if they do not have their own comment, #2999.

Bug Fixes

  • Fixed link resolution not working correctly in first comment on the file in some cases, #2994.
  • Optional methods are now rendered with a trailing ? in the reflection preview and signature, #2995.
  • The compilerOptions option now functions properly with non-boolean options, #3000.
  • Configuration errors within the compilerOptions option are now handled gracefully, #3000.
  • Fixed improper casing of "Type Declaration" header, #3002.

v0.28.10

Choose a tag to compare

@github-actions github-actions released this 10 Aug 18:14

Bug Fixes

  • Fixed inconsistent anchors on module pages for re-exports, #2990.
  • Markdown references which appear to be footnotes will no longer be checked for links, #2991.