Skip to content

Releases: TypeStrong/typedoc

v0.23.22

11 Dec 15:56
Compare
Choose a tag to compare

Features

  • Add support for defining the kind sort order, #2109.

Bug Fixes

  • Normalize all file paths on Windows, #2113.
  • Fix @link tags within lists, #2103.

v0.23.21

14 Nov 00:11
Compare
Choose a tag to compare

Features

  • Added support for a catch-all wildcard in externalSymbolLinkMappings, #2102.
  • Added support for TypeScript 4.9.

Thanks!

v0.23.20

03 Nov 03:11
Compare
Choose a tag to compare

Bug Fixes

  • Fixed comment discovery for @inheritDoc if inheriting from a function type alias, #2087.

v0.23.19

28 Oct 03:05
Compare
Choose a tag to compare

Bug Fixes

  • Fixed title link if titleLink option was not specified, #2085.

Thanks!

v0.23.18

23 Oct 20:14
Compare
Choose a tag to compare

Features

  • Improved error reporting when failing to find entry points, #2080, #2082.

Bug Fixes

  • Constructor parameter-properties will now use the @param comment for the parameter if available, #1261.
  • Fixed display of object types containing methods, #1788.
  • Fixed conversion of intrinsic string mapping types when converting without a type node, #2079.

v0.23.17

18 Oct 02:08
Compare
Choose a tag to compare

Features

  • Added titleLink, navigationLinks and sidebarLinks options to add additional links to the rendered output, #1830.
  • Added sourceLinkTemplate option to allow more flexible specification of remote urls.
    Deprecated now redundant gitRevision detection starting with https?:// introduced in v0.23.16, #2068.

Thanks!

v0.23.16

10 Oct 21:15
Compare
Choose a tag to compare

Features

  • Object types will now be pretty printed, #1793.
  • Added support for specifying the tsconfig.json file in packages mode with { "typedoc": { "tsconfig": "tsconfig.lib.json" }} in package.json, #2061.
  • In packages mode, readme files will now be automatically included if present, #2065.
  • Added support for specifying the base file url for links to source code, #2068.

Bug Fixes

  • Private parameter properties will no longer be ignored, #2064.

Thanks!

  • @captainTorch

v0.23.15

18 Sep 18:08
Compare
Choose a tag to compare

Features

  • TypeDoc will now treat @typedef {import("foo").Bar<Z>} Baz type declarations which forward type parameters to the imported
    symbol as re-exports of that symbol, #2044.

Bug Fixes

  • TypeDoc will now prefer comments on variable declarations over signature comments, #2042.
  • Fixed double rendering of "Type Parameters" header, #2054.
  • Fixed double rendering of "Hierarchy" header, #2053.
  • Removed unused widgets.png and widgets@2x.png files from generated assets folder.

v0.23.14

03 Sep 12:18
Compare
Choose a tag to compare

Features

  • Added support for defining one-off external link mappings with externalSymbolLinkMappings see
    the documentation for usage examples and caveats, #2030.
  • External link resolvers defined with addUnknownSymbolResolver will now be checked when resolving @link tags, #2030.
    Note: To support this, resolution will now happen during conversion, and as such, Renderer.addUnknownSymbolResolver has been
    soft deprecated in favor of Converter.addUnknownSymbolResolver. Plugins should update to use the method on Converter.
    DefaultThemeRenderContext.attemptExternalResolution has also been deprecated since it will repeat work done during conversion,
    use ReferenceType.externalUrl instead.
  • Added Converter.addUnknownSymbolResolver for use by plugins supporting external links.

Bug Fixes

  • Fixed conversion of object literal types containing construct signatures, #2036.
  • Fixed centering of title bar on wide displays, actually this time, #2046.

v0.23.13

01 Sep 00:56
Compare
Choose a tag to compare

Bug Fixes

  • Fixed packages mode bug introduced in 0.23.12 (again), #2043.