Sourced from typedoc's releases.
v0.25.6
Bug Fixes
- Fixed infinite loop caused by a fix for some complicated union/intersection types, #2468.
- Improved infinite loop detection in type converter to reduce false positives.
v0.25.5
Features
- Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, #182.
- Added a
--navigation.includeFolders(default:true) option to create nested navigation for projects which include many entry points, #2388.- Type parameters on functions/classes can will now link to the "Type Parameters" section, #2322. Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
- TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains
@paramtags which do not apply, #2368.- Extended reflection preview view for interfaces to include type parameters, #2455.
- Added special cases for converting methods which are documented as returning
thisor acceptingthisas a parameter, #2458. Note: This will only happen if a method is declared asmethod(): this, it will not happen if the method implicitly returnsthisas the compiler strips that information when creating types for a class instance.- Improved handling of functions with properties. Previous TypeDoc versions would always create a separate namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged with a namespace. If the properties are added via
Object.assignor via property assignment on the function TypeDoc will now instead add the properties to the function's page, #2461.Bug Fixes
- If both an interface and a variable share a name/symbol, TypeDoc will no longer link to the variable when referenced in a type position, #2106.
notDocumentedvalidation will no longer require documentation for data within parameters that cannot be documented via@param, #2291.- "defined in" locations for signatures will now always be contained within the function declaration's location. This prevents defined in sometimes pointing to node_modules, #2307.
- Type parameters will now be resolved for arrow-methods on classes like regular class methods, #2320.
- TypeDoc now inherits
typedocOptionsfields from extended tsconfig files, #2334.- Methods which return function types no longer have duplicated comments, #2336.
- Comments on function-like type aliases will now show up under the type alias, rather than nested within the type declaration, #2372.
- Improved detection of default values for parameters with destructured values, #2430.
- Fix crash when converting some complicated union/intersection types, #2451.
- Navigation triangle markers should no longer display on a separate line with some font settings, #2457.
@groupand@categoryorganization is now applied later to allow inherited comments to create groups/categories, #2459.- Conversion order should no longer affect link resolution for classes with properties whose type does not rely on
this, #2466.- Keyword syntax highlighting introduced in 0.25.4 was not always applied to keywords.
- Module reflections now have a custom
Micon rather than sharing with the namespace icon. Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.- If all members in a group are hidden from the page, the group will be hidden in the page index on page load.
Sourced from typedoc's changelog.
v0.25.6 (2024-01-01)
Bug Fixes
- Fixed infinite loop caused by a fix for some complicated union/intersection types, #2468.
- Improved infinite loop detection in type converter to reduce false positives.
v0.25.5 (2024-01-01)
Features
- Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, #182.
- Added a
--navigation.includeFolders(default:true) option to create nested navigation for projects which include many entry points, #2388.- Type parameters on functions/classes can will now link to the "Type Parameters" section, #2322. Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
- TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains
@paramtags which do not apply, #2368.- Extended reflection preview view for interfaces to include type parameters, #2455.
- Added special cases for converting methods which are documented as returning
thisor acceptingthisas a parameter, #2458. Note: This will only happen if a method is declared asmethod(): this, it will not happen if the method implicitly returnsthisas the compiler strips that information when creating types for a class instance.- Improved handling of functions with properties. Previous TypeDoc versions would always create a separate namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged with a namespace. If the properties are added via
Object.assignor via property assignment on the function TypeDoc will now instead add the properties to the function's page, #2461.Bug Fixes
- If both an interface and a variable share a name/symbol, TypeDoc will no longer link to the variable when referenced in a type position, #2106.
notDocumentedvalidation will no longer require documentation for data within parameters that cannot be documented via@param, #2291.- "defined in" locations for signatures will now always be contained within the function declaration's location. This prevents defined in sometimes pointing to node_modules, #2307.
- Type parameters will now be resolved for arrow-methods on classes like regular class methods, #2320.
- TypeDoc now inherits
typedocOptionsfields from extended tsconfig files, #2334.- Methods which return function types no longer have duplicated comments, #2336.
- Comments on function-like type aliases will now show up under the type alias, rather than nested within the type declaration, #2372.
- Improved detection of default values for parameters with destructured values, #2430.
- Fix crash when converting some complicated union/intersection types, #2451.
- Navigation triangle markers should no longer display on a separate line with some font settings, #2457.
@groupand@categoryorganization is now applied later to allow inherited comments to create groups/categories, #2459.- Conversion order should no longer affect link resolution for classes with properties whose type does not rely on
this, #2466.- Keyword syntax highlighting introduced in 0.25.4 was not always applied to keywords.
- Module reflections now have a custom
Micon rather than sharing with the namespace icon. Note: The default CSS still colors both modules and namespaces the same, as it is generally uncommon to have both in a generated site.- If all members in a group are hidden from the page, the group will be hidden in the page index on page load.
972d4f7 Update changelog for release759aa64 Bump version to 0.25.699a8da5 Improve recursive type detection914f9bb Fix infinite loop3e2240c Update supported versions in SECURITYf632cd8 Update changelog for release500706d Bump version to 0.25.52ce3796 Add hierarchy.html page to docs0117c99 Add --navigation.includeFolders65c83a9 Conversion order should not affect link resolution